Download the PHP package elevenlab/documentarian without Composer
On this page you can find all versions of the php package elevenlab/documentarian. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package documentarian
Documentarian
Simply write beautiful API documentation.
This project is a fork of the original Documentarian PHP porting of Slate API documentation tool. This fork will allow you to build API documentation for multiple API versions.
If PHP is not your thing and you're more into nodeJS, why not give Whiteboard a try?
Installation
To install Documentarian globally run
Create documentation
To create a documentation project run
if folder is not specified the documentation will be created in the current working directory.
Example:
Create docs for specific api version
To create an api-specific documentation run the following command
A folder named <version-name> will be created in <documentation-folder>/source/<version-name>. Edit the index.md
file in this folder to customize your api-specific documentation.
Example
Generate documentation pages
To generate .html files of the api-specific documentation run the command
where <folder> is your documentation parent folder. This will create a public folder inside your <folder> that
contains both frontend assets (like css and javascript) and the generated .html pages of your api documentation versions.
Example
The above command will generate a public folder inside kittens-api that consists of the following content:
cssfolder - contains style assetsimagesfolder - contains images used in the documentationjsfolder - contains JavaScript scripts used by the documentation pagev1.htmlfile - Documentation page for api versionv1v2.htmlfile - Documentation page for api versionv2
Changing template structure
If you wish to change the documentation file template, edit the file <documentation-foler>/views/index.blade.php
as you like.
Setting version links
To setup versions links that points to the right api version documentation page, edit the section
version in index.md:
For each version you can set the following parameters:
link- Link of the documentation page (href)target- Target ofhreflink (see HTML target attribute)name- Custom version name to be displayed on the rendered page, leave blank if you wish to use plain version name
In depth documentation
For further documentation on how to customize theme and other aspects, read the official whiteboard documentation.
Slate / Whiteboard compatibility
Since both Documentarian and Slate use regular markdown files to render the API documentation, your existing Slate API documentation should work just fine. If you encounter any issues, please submit an issue.
Contributors
Slate was built by Robert Lord while at TripIt.
Documentarian was built by Marcel Pociot.
Multi-version Documentarian was built by Valerio Cervo @ Eleven
All versions of documentarian with dependencies
mnapoli/silly Version ~1.0
illuminate/view Version 5.*
mnapoli/front-yaml Version ^1.5
windwalker/renderer Version 3.*