https://github.com/iolanguage/docio
Documentation generator for Eerie packages
https://github.com/iolanguage/docio
docs documentation documentation-generator io site-generator static-site-generator
Last synced: 11 months ago
JSON representation
Documentation generator for Eerie packages
- Host: GitHub
- URL: https://github.com/iolanguage/docio
- Owner: IoLanguage
- License: mit
- Created: 2017-11-26T22:12:41.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-11-05T18:26:11.000Z (about 5 years ago)
- Last Synced: 2025-01-21T00:48:49.399Z (about 1 year ago)
- Topics: docs, documentation, documentation-generator, io, site-generator, static-site-generator
- Language: CSS
- Homepage: https://iolanguage.github.io/docio
- Size: 5.17 MB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Docio
=====
Documentation generator for [Eerie](https://github.com/AlesTsurko/eerie)
packages.
## Install
Docio ships with Eerie by default. If you've installed
[Eerie](https://github.com/AlesTsurko/eerie) you already have Docio.
## Usage
For the API documentation and guide check Docio's site (which is also an example
of generated output): http://iolanguage.github.io/docio
### CLI
```
docio package=/path/to/package [template=/path/to/template]
```
This command recursively searches for files with extensions "io", "docio", "c"
and "m" in the `source` and `io` directories. Then it extracts documentation
from theses files and compiles HTML using either the provided or default
template. After that it put all the documentation in `docs` folder in the
package directory.
### Documentation Comments Format
You need to add your object to a category first. The category can be named
whatever you like. You'll get more understanding of what is a category, when you
generate your docs. So just try it and see.
```Io
//metadoc Prototype category API
```
Optionally add a description to the object:
```Io
/*metadoc Prototype description
Desciption goes here.
*/
```
Then comment out your public API like this:
```Io
//doc Prototype slotName(args) Description
```
Markdown is fully supported.
### Writing Templates
You should provide two template files: `main_template.html` and
`prototype_template.html`. The first one is used to generate the main page. The
second is for the documentation pages.
In the template files you can use Io code:
```Io
#{"Hello"}
```
Check out `template` folder to get an example.