diff --git a/MANIFEST.in b/MANIFEST.in index 92aba4a..3865361 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,4 @@ recursive-include yhttp/markdown/templates * recursive-include yhttp/markdown/static * +recursive-include yhttp/markdown/styles * recursive-include yhttp/markdown/defaultmetadata * diff --git a/README.md b/README.md index f9af9e6..928dd9f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,23 @@ Markdown server using yhttp. + +## Features + +- Serve a directory of markdown files and subdirectories as HTML using + [markdown2](https://github.com/trentm/python-markdown2). +- Personalizable favicon, touch-icon logo and etc. +- Syntaxt highlighting for code blocks + themes using + [pygment](https://pygments.org/). +- Copy-to-clipboard buttons for code-blocks and HTML bookmarks. +- Resizable sidebat and page layout powered by CSS Flexbox. +- Breadcrumbs (path) navigator. + + ## Install +```bash +pip install yhttp-markdown +``` ## Usage diff --git a/TODO.md b/TODO.md index 7e22c6f..9cadeb0 100644 --- a/TODO.md +++ b/TODO.md @@ -1,5 +1,7 @@ # Now +- current dir - readme + - screenshot ## later # cache assets diff --git a/setup.py b/setup.py index 6b3fef0..b55eaf7 100644 --- a/setup.py +++ b/setup.py @@ -45,6 +45,7 @@ package_data={'yhttp.markdown': [ 'yhttp/markdown/templates', 'yhttp/markdown/static', + 'yhttp/markdown/styles', 'yhttp/markdown/defaultmetadata', ]}, entry_points={