TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

MkDocs 1.0

115 点作者 kylebarron将近 7 年前

13 条评论

therealmarv将近 7 年前
We migrated a while ago all our python docs from sphinx and the free readthedocs to mkdocs. Two main reasons:<p>- 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.<p>- readthedocs was unreliable for us but we also did not wanted to pay for our open source software documentation generation + hosting.<p>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)<p>End result: <a href="https:&#x2F;&#x2F;docs.pybossa.com" rel="nofollow">https:&#x2F;&#x2F;docs.pybossa.com</a> (hosted on GitHub)<p>Source: <a href="https:&#x2F;&#x2F;github.com&#x2F;scifabric&#x2F;docs.pybossa.com" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;scifabric&#x2F;docs.pybossa.com</a>
评论 #17721750 未加载
评论 #17727014 未加载
评论 #17718708 未加载
评论 #17719051 未加载
评论 #17719670 未加载
评论 #17717568 未加载
mc_将近 7 年前
We moved the majority of docs for our projects (<a href="https:&#x2F;&#x2F;github.com&#x2F;2600hz" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;2600hz</a>) to use mkdocs to build our doc sites (<a href="https:&#x2F;&#x2F;docs.2600hz.com&#x2F;dev" rel="nofollow">https:&#x2F;&#x2F;docs.2600hz.com&#x2F;dev</a> <a href="https:&#x2F;&#x2F;docs.2600hz.com&#x2F;ui" rel="nofollow">https:&#x2F;&#x2F;docs.2600hz.com&#x2F;ui</a> etc).<p>I have a simple script that receives github webhooks on PR merges to master that fetches the latest version of master and builds the site. So from PR merge to the docs site being updated is now seconds of time.<p>We also integrated building the doc sites into our CI process so PRs will fail if they would cause mkdocs to fail to build the site (borked yaml, make sure docs are included in the yaml, other things).<p>This has been a boon for our community of users and developers. Coupled with our AST parsers that look for code changes that require doc changes, we&#x27;re getting better about alerting developers of the need to document something, and reviewers of the need if the developer forgot. Not a panacea but has significantly improved doc coverage for Kazoo which has a broad set of APIs available to different types of users.<p>Cheers to 1.0!
lima将近 7 年前
How do mkdocs and asciidoctor compare to reStructuredRext&#x2F;Sphinx nowadays?
评论 #17717610 未加载
评论 #17718771 未加载
评论 #17717550 未加载
zimmund将近 7 年前
If anyone finds it useful, some time ago I made a Docker image of `mkdocs` [1] (with a few extensions, check the dockerfile for details).<p>[1]: <a href="https:&#x2F;&#x2F;hub.docker.com&#x2F;r&#x2F;elamperti&#x2F;docker-mkdocs&#x2F;" rel="nofollow">https:&#x2F;&#x2F;hub.docker.com&#x2F;r&#x2F;elamperti&#x2F;docker-mkdocs&#x2F;</a>
jcstk将近 7 年前
Awesome and congrats. We started using MkDocs for <a href="https:&#x2F;&#x2F;aqueduct.io&#x2F;docs&#x2F;" rel="nofollow">https:&#x2F;&#x2F;aqueduct.io&#x2F;docs&#x2F;</a>, and have since used it for a ton of projects. Some things that we found really useful were that it indexes all of your content for full text search automatically, and it’s stupid simple to deploy it to gh-pages. With a minimal amount of scripting, we push to a mkdocs source branch and it builds and deploys nearly immediately. It has saved us a ton of time and delivered tremendous value.
评论 #17717710 未加载
old-gregg将近 7 年前
We love MkDocs! When we originally discovered it we believed it was &quot;good for small projects&quot; but as our product got more complicated we actually never hit any issues. It&#x27;s amazingly easy to use, extend and customize with great results:<p><a href="https:&#x2F;&#x2F;gravitational.com&#x2F;teleport&#x2F;docs" rel="nofollow">https:&#x2F;&#x2F;gravitational.com&#x2F;teleport&#x2F;docs</a>
yread将近 7 年前
I&#x27;ve just started writing documentation for my project in MkDocs like last week. So far, it&#x27;s pretty good.<p>But I had to switch off the search functionality because it was causing a slowdown when displaying the page (you couldn&#x27;t even scroll?).<p>Also I would appreciate if they made changing the theme easier - currently there is only a minified bootstrap css which is a PITA to modify.
评论 #17719078 未加载
ngrilly将近 7 年前
What about i18n&#x2F;multilingual documentation with MkDocs?<p>Edit: Some answers in the issue tracker: <a href="https:&#x2F;&#x2F;github.com&#x2F;mkdocs&#x2F;mkdocs&#x2F;issues?utf8=%E2%9C%93&amp;q=is%3Aissue+i18n" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;mkdocs&#x2F;mkdocs&#x2F;issues?utf8=%E2%9C%93&amp;q=is%...</a>
jamesadevine将近 7 年前
Yet they still have no way for me to buy them a beer.<p><a href="https:&#x2F;&#x2F;github.com&#x2F;mkdocs&#x2F;mkdocs&#x2F;issues&#x2F;892" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;mkdocs&#x2F;mkdocs&#x2F;issues&#x2F;892</a>
评论 #17718638 未加载
gravypod将近 7 年前
The 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?
评论 #17723542 未加载
Jahak将近 7 年前
<a href="http:&#x2F;&#x2F;asciidoctor.org" rel="nofollow">http:&#x2F;&#x2F;asciidoctor.org</a>
JakeTyo将近 7 年前
Thanks for reminding me to updated and test my container. ;)
abakus将近 7 年前
The proliferation of yaml is rather unfortunate.
评论 #17719101 未加载