python gather for markdown to simple pandoc
markdown is a great way to document your thoughts and code. If small md fragments are supposed to be combined into a single document using pandoc, certain problems may show up:
- keeping right order
- images in sub folders
- references
- links to files in md are suddenly dead in doc
FIXME
markdown or simple md is available in a lot of state-of-the-art platform, a few format instruction allow you to structure information into readable look, with any overhead. it's text rendered into html.
benefits:
- easy to learn
- easy to remember
- lightweight
- safe, no macros or anything that might invite an attack
some manual found online
pandoc is a flexible document converter.
see manual
It can read and write:
- markdown
- html
- odt
- docx
- tex
- epub
- and more
more on github
a python script shall read one md file, analyse it and walk through each md file link.
all found md files shall be compacted into a new single one.
all images links shall be copied into a single media folder.
suggested tree structure shall be flattened out.
links to other file types, determined by extension, shall be modified to repo links.
- python 3 implementation
- CLI, command line interface
- configuration xml
- project language English
- coding language English, sort of
every contribution is very much appreciated.
join, discuss, use and share