Transform markdown files into html with styles of github
Project description
Motivation
Basically, You may want to convert md files into Html looks exactly like github does.
Maybe you would try pandoc, but html it generates looks not very well.
So, I start writing this small tool, inspired by grip
Features
mdtogh can convert your md files into html files like github does with features belows:
toc support
index.html for your book
next/prev files link
file regexp to select your md files
custom template(still working)
offline renderer(still working)
demo
I’ve generate a book written by julycoding: The-Art-Of-Programming-By-July.
Demo link: taop.marchtea.com
You can check on that.
Installation
From pypi
$ pip install mdtogh
Also, you can clone repo & install with setup.py.
$ git clone https://github.com/marchtea/md_to_github_html.git
$ cd md_to_github_html
$ python setup.py install
Maybe you will need add sudo
Usage
Generate one or more files
$ cd mdfiles
$ mdtogh 01.md 02.md 03.md
Generate all md files in current directory
$ cd mdfiles
$ mdtogh
Generate md files in other directory
$ mdtogh ../mdfiles
Generate files with file reg support
$ cd mdfiles
$ mdtogh --file_reg='^\d.+\.md'
Generate files with toc & toc_depth support
$ cd mdfiles
$ mdtogh --toc --toc_depth=2 --file_reg='^\d.+\.md'
Generate files with additional book info
$ cd mdfiles
$ mdtogh --toc --book='book.json'
The format of book.json is given below.
Recommanded options to generate book
$ mdtogh --css --toc --book='book.json' --file_reg='your reg exp'
Recommanded options to generate several files
$ mdtogh 01.md 02.md
For more options
mdtogh -h
Something You May Notice
As to generate files exactly like github does, the easiest way is to use api if offers. But it has its own limits.
60 for anonymous requests an hour
5000 for requests using Basic Authentication an hour
So, you may using –user & –pass options
$ mdtogh --user='your_github_username' --pass='your login password'
Your info are sended through https which is safe. mdtogh will not save any of it.
book.json
{
"title": "Demo book",
"description": "This is a book.",
"coverimage": "demo.jpg"
}
TODO
mdtogh is still on developing.
Features are developing or will be add later.
support recursive options.
custom html template
add toc in content.html
show ratelimit-remaining after generate complete
offline renderer
Contibuting
Any help will be appreciated.
open issues if you find any questions
complete one in TODO list
add features you like
feel free to open pull request
Links
Change Log
2014/3/3 0.0.2 add –toc_depth support, fix get_html_name bug
2014/3/1 0.0.1 first release
Thanks
Special thanks to grip. Without its excellent work, this tool can’t be done.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mdtogh-0.0.1.macosx-10.9-intel.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfd60a9812496785547426f638bbeaf581cbcc98eacb5abf646fbe4c2bee37ba |
|
MD5 | 8f8905919111f172736aa28c91265df2 |
|
BLAKE2b-256 | 4b86c0bc6f3522ec9c47515f1a481ed310d15b5cf6d95619d65f846ffa397dcb |