Basic implementation of mkdocs

builtree / handwrite

Handwrite generates a custom font based on your handwriting sample.

https://pypi.org/project/handwrite/

MIT License

366 stars 46 forks source link

Basic implementation of mkdocs #46

Closed withoutwaxaryan closed 3 years ago

withoutwaxaryan commented 3 years ago

Initial setup of Mkdocs, added the README section in docs.

Usage : pip install mkdocs

mkdocs serve - to see changes on local host

Note: The docs havent been built or deployed yet.

yashlamba commented 3 years ago

I know this is WIP but quick suggestions:

Checkout this theme: https://squidfunk.github.io/mkdocs-material/
No need to create a new folder for the docs, mkdocs.yml can be in project root directory and content in docs folder. (ex: https://github.com/cod-ed/simulate)

yashlamba commented 3 years ago

@withoutwaxaryan I think you referred to an old version of the README, multiple things are missing in the docs which are in the readme, make sure you are on the latest version.

yashlamba commented 3 years ago

And can you fix this link too: https://github.com/cod-ed/handwrite/blame/main/README.md#L77, make it an absolute link in the docs.