matthewdeanmartin / markdown_build

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

markdown_build

This is a multi-tool markdown build script. By that I mean, it checks and transforms the markdown. But it also looks at the quality of the English.

This would be used in conjunction with some other tool, like Github pages or pelican.

Transformations: format, compile to HTML

Checks: markdown linting, spelling, tone, grammar, hyperlinks

Installation

pip install markdown_build

Usage

Locally, run report.sh to autoformat and then get a listing of potential problems.

Because this is English many of these problems might be fine to live with.

Optionally, run build.sh to autoformat and do a trial conversion to HTML.

Formatters

Ideas for the future

About

License:MIT License


Languages

Language:Shell 43.2%Language:Python 40.6%Language:MDX 12.6%Language:HTML 3.6%