Skip to content

๐Ÿ“š A simple python script that transforms your commented code into a detailed documentation page.

License

Notifications You must be signed in to change notification settings

Dogo6647/brdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

13 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

<br>down

A simple python automation script that transforms your // commented code into a detailed documentation HTML page. Useful for breaking down and quickly turning fully-commented example scripts into their own markdown-style docpages.

Usage

python3 brdown.py [code-file] -o [output file]

If no output file is specified, brdown will just spit out all the HTML to the console.

Example result

brdown example

About

๐Ÿ“š A simple python script that transforms your commented code into a detailed documentation page.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published