Fix: styles directory added to package data and a feature list is wri…

…tten.
yhttp · Aug 31, 2024 · fe9c6c1 · fe9c6c1
1 parent c7f5bee
commit fe9c6c1
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git 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
@@ -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
@@ -1,5 +1,7 @@
 # Now
+- current dir
 - readme
+  - screenshot
 
 ## later
 # cache assets
diff --git 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={