Skip to content

Simple Markdown documentation generator for many popular programming languages. Easily extensible and easy to use.

License

Notifications You must be signed in to change notification settings

Sebidev/Dokyumento

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Dokyumento

Dokyumento is a simple Markdown documentation generator for many popular programming languages. Easily extensible and easy to use.

Features

  • Extracts single-line and multi-line comments.
  • Supports multiple programming languages.
  • Generates Markdown files for easy documentation.

Supported Languages

  • C/C++
  • JavaScript
  • TypeScript
  • Go
  • Rust
  • Swift
  • Python

Installation

Ensure you have Python 3.6 or higher installed. You can clone the project directly from GitHub and run as module or direct install.

git clone https://github.com/sebidev/Dokyumento.git
cd Dokyumento
python -m venv yourenv && source yourenv/bin/activate 
pip install .

Use

python -m dokyumento <directory>

About

Simple Markdown documentation generator for many popular programming languages. Easily extensible and easy to use.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages