https://github.com/jbroadway/docusaur
API documentation browser for software projects, written as an Elefant CMS app.
https://github.com/jbroadway/docusaur
Last synced: about 2 months ago
JSON representation
API documentation browser for software projects, written as an Elefant CMS app.
- Host: GitHub
- URL: https://github.com/jbroadway/docusaur
- Owner: jbroadway
- Created: 2012-04-11T02:15:36.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2012-04-11T04:37:24.000Z (about 13 years ago)
- Last Synced: 2025-01-13T12:27:19.617Z (3 months ago)
- Language: PHP
- Homepage: http://www.elefantcms.com/
- Size: 121 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docusaur
**STATUS: PRE-ALPHA**
API documentation browser for software projects, made to work like the php.net
website. Pages are created manually instead of being auto-generated, providing
for more information than docblocks can provide on their own.
Usage:
1. Install on an Elefant website
2. Set the error_handler to docusaur/index
3. Add `sitemap/generate[] = docusaur/sitemap` to hooks
4. Edit apps/docusaur/conf/config.php to configure
5. Create a layout with a sidebar containing {! docusaur/nav !}
6. Go to Tools > Docusaur and add your content
Supports [Disqus](http://disqus.com/) for comments, and searching via URLs,
e.g., `/I18n::get` would forward to `/1.2/I18n/get` where `1.2` is the
default version.
To do:
* Admin area - delete pages
* Sitemaps integration
* Navigation
* Page display
* Default styling
* Disqus support
* CLI handler to import PHP files from a folder
* Duplicate old versions to new