Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

more documentation #1

Open
cs01 opened this issue May 17, 2019 · 1 comment
Open

more documentation #1

cs01 opened this issue May 17, 2019 · 1 comment

Comments

@cs01
Copy link

cs01 commented May 17, 2019

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
Copy link

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants