Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 756 Bytes

File metadata and controls

41 lines (32 loc) · 756 Bytes

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>