Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrispyles/markdown-to-html
Markdown to HTML converter
https://github.com/chrispyles/markdown-to-html
Last synced: 20 days ago
JSON representation
Markdown to HTML converter
- Host: GitHub
- URL: https://github.com/chrispyles/markdown-to-html
- Owner: chrispyles
- License: bsd-3-clause
- Created: 2019-08-07T07:11:53.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-16T09:44:06.000Z (almost 4 years ago)
- Last Synced: 2024-10-11T19:12:09.486Z (about 1 month ago)
- Language: Python
- Homepage: https://md2html.chrispyles.io
- Size: 63.5 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markdown to HTML Converter
[](https://travis-ci.org/chrispyles/markdown-to-html) [](https://codecov.io/gh/chrispyles/markdown-to-html)
This is a converter from Markdown to HTML with advanced support for Markdown tables and GFM syntax highlighting. This package relies on `markdown2` for converting basic Markdown to HTML and `pygments` to support code to HTML conversion for syntax highlighting. The default (and, currently, only) theme for this package is Monokai.
You can find a sample of a site generated from this package at [https://mcautograder.chrispyles.io](https://mcautograder.chrispyles.io).
## Installation
The converter is installed using pip:
```
pip install md2html
```
## Usage
This package an executable that can be run from the command line:
```
md2html ...
```
Here is the help entry for this package:
```
usage: md2html [-h] [-s SITE] [-n NAV] ...
convert Markdown to HTML
positional arguments:
files files to be converted to HTML
optional arguments:
-h, --help show this help message and exit
-s SITE, --site-info SITE
add metadata to the HTML files
-n NAV, --nav NAV add a YAML file to use for navigation menu
```
Running the converter will place HTML files in the same directory as your Markdown files, with the `.md` extension replaced with `.html`. The HTML files come with CSS in a `style` tag in the `head`.
### Page Metadata
If you would like to add metadata to your page, including a navigation menu, do so by creating a YAML file containing this metadata and passing the file path to the `-s` flag, e.g.
```
md2html -s meta.yml ...
```
The structure of your YAML file should be:
```yaml
title: page title
author: page author
description: page description
navigation:
nav_title: navigation menu title
links:
- title: link name
url: HTML file path
- title: ...
url: ...
...
```
Currently, the `title` must be set if you use this option. The converter does not yet support navigation submenus, so all links will be rendered as
* [Link 1]()
* [Link 2]()
* [Link 3]()
* etc.
### Navigation Menu
The converter also supports adding only a navigation menu without page metadata. To do this, pass a YAML file to the `-n` flag. It should have the following structure:
```yaml
nav_title: navigation menu title
links:
- title: link name
url: HTML file path
- title: ...
url: ...
...
```
## Changelog
**v1.3.0:**
* Added unit tests & Travis CI
* Refactored `bin/md2html` so that parser code is in `md2html/__init__.py`
**v1.2:**
* Added YAML syntax highlighting
**v1.1:**
* Added docstrings for documentation
* Moved some utils out of `md2html/converter.py`
**v1.0:**
* Changed to Boostrap CSS
**v0.1:**
* Initial release