“”

Sphinx Documentation Viewer Plugin Sphinx Documentation Viewer Plugin

restdoc / stable

Seamlessly embeds Sphinx/reStructuredText-based documentation into your TYPO3 website. Instead of publishing your various manual, in-house documents, guides, references, ... solely as PDF, render them as JSON and use this extension to show them as part of your website to enhance the overall user experience and Search Engine Optimization (SEO). Lets you merge the chapter structure with the breadcrumb menu and much more. Documentation styles automatically inherit from your corporate design.

This version supports TYPO3

Older versions also support TYPO3

Composer support

composer req causal/restdoc

Tags

#documentation #embedding #seo

Last upload comment

Standard maintenance release.
In use for many months in production and high time to make it available to everybody as some prefer a release as fetching from git :-)

Downloads by month

Download 2.1.0 Extension Manual Found an Issue? Code Insights Packagist.org Donate and Give Kudos Crowdin translations
Author
Xavier Perseguers
Company
Causal Sàrl
Last update
29. Feb 2024
First upload
05. May 2012
Downloads
17,117
Category
Frontend Plugins
Dependencies
  • PHP (7.4.0 - 8.3.99)
  • TYPO3 (9.5.0 - 11.5.99)

Installation

  1. Download ZIP file
  2. Log into your TYPO3 backend
  3. Go to Extension Manager module
  4. Press the upload button on the top bar
  5. Select the ZIP file and upload it. If you want to overwrite an existing extension installation, activate the checkbox.
  1. Go to your folder where the root composer.json file is located
  2. Type: composer req causal/restdoc to get the latest version that runs on your TYPO3 version.
  1. Download T3X file
  2. Log into your TYPO3 backend
  3. Go to Extension Manager module
  4. Press the upload button on the top bar
  5. Select the T3X file and upload it. If you want to overwrite an existing extension installation, activate the checkbox.

Other extensions by this user (12)

Version history

Version Upload comment Works with TYPO3 Download
2.1.0 / stable
February 29, 2024
Standard maintenance release.
In use for many months in production and high time to make it available to everybody as some prefer a release as fetching from git :-)
9.5.0 - 11.5.99 Download
2.0.0 / stable
February 15, 2021
Standard maintenance release.
8.7.0 - 11.5.99 Download
1.7.0 / stable
March 05, 2020
Compatibility with TYPO3 v9 and TYPO3 v10.
8.7.0 - 10.3.99 Download
1.6.0 / stable
March 30, 2016
Additional methods for supporting new docs.typo3.org theme (EXT:sphinx 2.4).
Compatibility with TYPO3 v8 and PHP 7.
Details on https://forge.typo3.org/projects/extension-restdoc/wiki/RESTDOC_160
6.2.0 - 8.99.99 Download
1.5.1 / stable
November 10, 2015
Last bits of fine-tuning to be ready for TYPO3 7 LTS.
Details on https://forge.typo3.org/projects/extension-restdoc/wiki/RESTDOC_151
6.2.0 - 7.99.99 Download
1.5.0 / stable
June 24, 2015
Extended support for RealURL (simply said: beautiful URLs).
Details on http://forge.typo3.org/projects/extension-restdoc/wiki/RESTDOC_150
6.2.0 - 7.99.99 Download
1.4.0 / stable
December 04, 2014
Compatibility with TYPO3 6.2-7.x.
If you need support for TYPO3 4.5-6.1, please use version 1.3 instead.
Details on http://forge.typo3.org/projects/extension-restdoc/wiki/RESTDOC_140
6.2.0 - 7.99.99 Download
1.3.2 / stable
April 22, 2014
Regular maintenance release. Compatibility with Flow manuals.
Details on http://forge.typo3.org/projects/extension-restdoc/wiki/RESTDOC_132
4.5.0 - 6.2.99 Download
1.3.1 / stable
October 15, 2013
Compatibility with TYPO3 6.2 LTS.
BEWARE: default file is now expected to be \"Index.rst\" (UpperCase) and not \"index.rst\" anymore. Adapt TypoScript constant if needed.
Details on http://forge.typo3.org/projects/extension-restdoc/wiki/RESTDOC_131
4.5.0 - 6.2.99 Download
1.3.0 / stable
June 04, 2013
Compatibility with official TYPO3 manuals and integration with EXT:sphinx 0.5.0
4.5.0 - 6.1.99 Download
1.2.1 / stable
April 11, 2013
Regular bugfix release. Invalid index definition in database table. Search module now compatible with upcoming Sphinx v1.2.
Release notes: https://forge.typo3.org/projects/extension-restdoc/wiki/RESTDOC_121
4.5.0 - 6.1.99 Download
1.2.0 / stable
April 04, 2013
Now compatible with FAL in TYPO3 6.x.
Support for metadata and Sphinx advertisement (Wappalizer).
Built-in Sphinx search within the documentation.

Please check your deprecation log after upgrading.
4.5.0 - 6.1.99 Download
1.1.0 / stable
March 07, 2013
Support for general index, breadcrumb menu, menu of recent changes and integration of chapters into Google Sitemap (EXT:dd_googlesitemap).

BEWARE: Minor breaking changes, please consult corresponding bug tracker entries if ever you need help: https://for
4.5.0 - 6.0.99 Download
1.0.0 / stable
February 16, 2013
Bug fixes, better integration using TypoScript. Extension is now considered stable.
4.5.0 - 6.0.99 Download
0.1.0 / alpha
May 05, 2012
Initial release. Please read documentation.
Download