search

andyoakley / mkdocs-blog

Blogging in mkdocs
14 stars 7 forks source link

more documentation #1

Open cs01 opened 5 years ago

cs01 commented 5 years ago

This concept seems really useful and I want to give it a try, but documentation is sparse. Can you add more details on how to install and run mkdocs-blog? Maybe provide an example project?

tomkralidis commented 5 years ago

AFAICT this plugin requires a setup like:

mkdocs.yml
----docs/
--------YYYY/
------------MM/
----------------foo.md

at which point URLs would be http://localhost:8000/YYYY/MM/foo.html type thing.

@andyoakley I've made some local changes to this repo and would like to contribute back (structure, update/cleanup, licensing, docs), and at some point post to https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins because I think blogging in MkDocs is something that users would find valuable. Are you accepting contributions or is there anything I should know before submitting a PR?