Jump to content
  • Advertisement
Sign in to follow this  
sepul

pymdWiki: Document generation tool from markdown files

This topic is 1902 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

pymdWiki: Document generation tool from markdown files

 

Tried to find a good solution to generate/publish wiki from offline markdown files, didn't find anything useful so I've created this tool for this purpose

You just write markdown documents, run this program on the root directory of documentation files (.md), pick a theme, and it will generate html files out of them. Optionally you can specify an ftp server, the generated files will be uploaded to the ftp automatically.

 

Here's some features:

  • Recursive directory processing of .md files 
  • Preserves links and images
  • Themes with JSON config files
  • Automatic Table of contents (TOC) generation
  • Lightweight command line multi-platform program (written in python)

 

For more info about usage visit project page, windows binaries are also available in Downloads section for those who don't want to bother with python.

 

I've developed this for my other open-source project wiki, but here's a simple test that is generated with this program:

http://hmrengine.com/tmp/main.html

 

 

Share this post


Link to post
Share on other sites
Advertisement
Sign in to follow this  

  • Advertisement
×

Important Information

By using GameDev.net, you agree to our community Guidelines, Terms of Use, and Privacy Policy.

We are the game development community.

Whether you are an indie, hobbyist, AAA developer, or just trying to learn, GameDev.net is the place for you to learn, share, and connect with the games industry. Learn more About Us or sign up!

Sign me up!