mirror of
https://github.com/MatMoul/dokytree.git
synced 2024-12-23 08:06:11 +00:00
17 lines
478 B
Markdown
17 lines
478 B
Markdown
|
# dokytree
|
||
|
|
|
||
|
|
Documentation system that use simple yaml file in directory tree.
|
||
|
|
|
||
|
|
Requirements :
|
||
|
|
- nodejs 19 to launch app.js
|
||
|
|
- vscode to edit documentation
|
||
|
|
- chromium to view and print as pdf documentation
|
||
|
|
- wget to extract a static website of the documentation
|
||
|
|
|
||
|
|
Get started :
|
||
|
|
- Use a sample documentation
|
||
|
|
- Launch the server : node app.js doc.yaml
|
||
|
|
- Browse the doc with your browser : http://127.0.0.1:3000/
|
||
|
|
- Edit the doc (with vscode)
|
||
|
|
- Print the doc book as pdf with chromium
|