diff --git a/README.md b/README.md index 7311124..3915af8 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,20 @@ Example: md2indexhtml path/to/yourfile.md path/to/output/dir --template path/to/template.html --css path/to/custom.css --title "My Documentation" ``` +## Themes + +### Default Theme + +![Default](screenshots/index.jpg) + +### GoDocs Theme + +![GoDocs](screenshots/godocs.jpg) + +### DocBox Theme + +![GoDocs](screenshots/docbox.jpg) + # Python API You can also use the package programmatically in your Python code: diff --git a/md2indexhtml/__init__.py b/md2indexhtml/__init__.py index 021949d..de2dfd7 100644 --- a/md2indexhtml/__init__.py +++ b/md2indexhtml/__init__.py @@ -4,7 +4,7 @@ from .converter import convert_md_to_html # Version of the package -__version__ = "0.1.0" +__version__ = "0.1.1" # Define what is available when the package is imported __all__ = ["convert_md_to_html"] diff --git a/screenshots/docbox.jpg b/screenshots/docbox.jpg new file mode 100644 index 0000000..8cb9365 Binary files /dev/null and b/screenshots/docbox.jpg differ diff --git a/screenshots/godocs.jpg b/screenshots/godocs.jpg new file mode 100644 index 0000000..ed5ac15 Binary files /dev/null and b/screenshots/godocs.jpg differ diff --git a/screenshots/index.jpg b/screenshots/index.jpg new file mode 100644 index 0000000..34998e1 Binary files /dev/null and b/screenshots/index.jpg differ diff --git a/setup.py b/setup.py index 996aa07..53cf8b8 100644 --- a/setup.py +++ b/setup.py @@ -3,8 +3,8 @@ setup( name='md2indexhtml', - version='0.1.0', - description='Convert Markdown files to index.html for Odoo modules', + version='0.1.1', + description='Convert Markdown files to index.html', author='Your Name', author_email='fasilwdr@hotmail.com', url='https://github.com/fasilwdr/md2indexhtml', @@ -12,6 +12,7 @@ install_requires=[ 'markdown', ], + readme="README.md", classifiers=[ 'Programming Language :: Python :: 3', 'License :: OSI Approved :: MIT License',