https://github.com/zalari/docs-portal
Generates a static index.html file providing iframe based access to documents in subfolders relative to it.
https://github.com/zalari/docs-portal
Last synced: 4 months ago
JSON representation
Generates a static index.html file providing iframe based access to documents in subfolders relative to it.
- Host: GitHub
- URL: https://github.com/zalari/docs-portal
- Owner: zalari
- Created: 2017-02-09T13:21:31.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-09T13:39:42.000Z (over 9 years ago)
- Last Synced: 2025-01-19T08:45:10.374Z (over 1 year ago)
- Language: HTML
- Size: 2.93 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docs-portal
Generates a static index.html file providing iframe based access to documents in subfolders relative to it.
The template is based on [Material lite](https://getmdl.io) and will be customizable in a future release.
Usage: docs-portal COMMAND
Options:
| ARGUMENT, OPTIONS | DEFAULT |Â MANDATORY | DESCRIPTION |
| --: | :--- | :---: | :--- |
| `-t`, `--target` | - | yes | The target to generate and lookup folders |
| `--charset` | `utf-8` | no | The document charset |
| `--docs` | - | no | Force manually which folders to show by passing a string (e.g. 'foo bar') |
| `--language` | `en` | no | The document language |
| `--name` | `index.html` | no | The name of the file to write |
| `--title` | `Documentation portal` | no | The portal title |