m/dokytree
1
0
Fork 0
mirror of https://github.com/MatMoul/dokytree.git synced 2024-12-23 08:06:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
A versatil documentation system based on yaml files in directory tree with pugjs templates
1 Commit 2 Branches 7 Tags 4.7 MiB
JavaScript 62.4%
Pug 15.1%
Shell 14.7%
CSS 7.8%
56fa5970af
Go to file
MatMoul 56fa5970af Inital commit
2023-03-09 00:38:30 +01:00
samples Inital commit 2023-03-09 00:38:30 +01:00
src Inital commit 2023-03-09 00:38:30 +01:00
build.sh Inital commit 2023-03-09 00:38:30 +01:00
LICENSE Inital commit 2023-03-09 00:38:30 +01:00
README.md Inital commit 2023-03-09 00:38:30 +01:00

README.md

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