MkDocs 1.0
41–45 of 45 posts
Re: MkDocs 1.0
#42The search feature is nothing short of amazing. I love how fast it is. Is it scalable to large amounts of documentation? How is it indexed?
It flattens the text into one big json file and with some JS it searches this flat text file: https://github.com/Scifabric/docs.pybossa.com/blob/gh-pages/... (1.1 MB)
all done automatically on building the site.
There are for sure some limits to this approach because it's all in memory/browser but we only write some software documentation on our side and not really big books.
Re: MkDocs 1.0
#43We 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…
This is quite nice, high quality documentation, the template is eye-catchy, very nicely structured, well done!
thx :)
Re: MkDocs 1.0
#44What about i18n/multilingual documentation with MkDocs?
Edit: Some answers in the issue tracker: https://github.com/mkdocs/mkdocs/issues?utf8=%E2%9C%93&q=is%...
Re: MkDocs 1.0
#45We 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…
I really dislike .rst (and .md in Sphinx is less than great) so I'd love to switch from Sphinx. Do you know if there's mkdocs has an equivalent to Sphinx's autodoc?