https://github.com/matmoul/dokytree

A versatil documentation system based on yaml files in directory tree with pugjs templates
https://github.com/matmoul/dokytree

Last synced: 8 months ago
JSON representation

A versatil documentation system based on yaml files in directory tree with pugjs templates

• Host: GitHub
• URL: https://github.com/matmoul/dokytree
• Owner: MatMoul
• License: gpl-3.0
• Created: 2023-03-08T23:37:38.000Z (over 3 years ago)
• Default Branch: dev
• Last Pushed: 2024-10-31T20:24:57.000Z (over 1 year ago)
• Last Synced: 2025-03-17T00:41:24.599Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 4.41 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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