MkDocs 1.0
mkdocs.org
MkDocs 1.0
1–10 of 45 posts
Re: MkDocs 1.0
#2How do mkdocs and asciidoctor compare to reStructuredRext/Sphinx nowadays?
Re: MkDocs 1.0
#3If anyone finds it useful, some time ago I made a Docker image of `mkdocs` [1] (with a few extensions, check the dockerfile for details).
Re: MkDocs 1.0
#4We migrated a while ago all our python docs from sphinx and the free readthedocs to mkdocs. Two main reasons:
- we like markdown more and starting (actually we converted to markdown with pandoc) with a bunch of markdown files was a breeze. We also did not lost advanced documentation features because there are plenty of fantastic mkdocs plugins.
- readthedocs was unreliable for us but we also did not wanted to pay for our open source software documentation generation + hosting.
At the end we have an auto generated mkdocs with GitHub+Travis and all searchable with the fantastic mkdocs static page search functionality (maybe the biggest feature of mkdocs)
End result: https://docs.pybossa.com (hosted on GitHub)
Re: MkDocs 1.0
#5How do mkdocs and asciidoctor compare to reStructuredRext/Sphinx nowadays?
Also wondering about extensions, how are those handled? Or is this for plain documents only? For example in Sphinx you can mark up figures, youtube videos, graphviz graphs, etc. Are those plugins available with mkdocs?
What about a book with parts? That's one area that Sphinx falls down, and they've been dragging their feet on it so far.
Re: MkDocs 1.0
#6We migrated a while ago all our python docs from sphinx and the free readthedocs to mkdocs. Two main reasons: - we like markdown more and starting (actually we converted to markdown with pandoc) with a bunch of markdown files was a breeze. We also did not lost advanced documentation features because there are plenty of fantastic mkdocs plugins. - readthedocs was unreliable for us but we also did not wanted to pay for…
Github hosts your docs for free, with a custom domain name?
Re: MkDocs 1.0
#7How do mkdocs and asciidoctor compare to reStructuredRext/Sphinx nowadays?
Also wondering about extensions, how are those handled? Or is this for plain documents only? For example in Sphinx you can mark up figures, youtube videos, graphviz graphs, etc. Are those plugins available with mkdocs? What about a book with parts? That's one area that Sphinx falls down, and they've been dragging their feet on it so far.
There are plenty of mkdocs plugins for advanced documentation features.
Re: MkDocs 1.0
#8Yet they still have no way for me to buy them a beer.
Re: MkDocs 1.0
#9We migrated a while ago all our python docs from sphinx and the free readthedocs to mkdocs. Two main reasons: - we like markdown more and starting (actually we converted to markdown with pandoc) with a bunch of markdown files was a breeze. We also did not lost advanced documentation features because there are plenty of fantastic mkdocs plugins. - readthedocs was unreliable for us but we also did not wanted to pay for…
Github hosts your docs for free, with a custom domain name?
Github Pages doesn't cost money.
Re: MkDocs 1.0
#10We migrated a while ago all our python docs from sphinx and the free readthedocs to mkdocs. Two main reasons: - we like markdown more and starting (actually we converted to markdown with pandoc) with a bunch of markdown files was a breeze. We also did not lost advanced documentation features because there are plenty of fantastic mkdocs plugins. - readthedocs was unreliable for us but we also did not wanted to pay for…
Github hosts your docs for free, with a custom domain name?
Yep, just search for DNS CNAME handling on GitHub docs. We put also Cloudflare DNS in front of it to get TLS/SSL but I've heard this is not necessary anymore nowadays.