2021年世界各地的狮身人面像和马克顿
阅读文档致力于提高可访问性以及Sphinx自诞生以来的用户体验,并且包括文档所用的标记语言。多年前,在认真听取用户意见后,我们宣布了推荐标志帮助弥合降价的巨大流行拥有狮身人面像的强大能力。(现在不赞成使用MyST,请继续阅读以了解更多信息。)
毫无疑问,降价需求如此之大:这在很大程度上要归功于GitHub的巨大人气,标记是当今开源中使用最广泛的标记语言项目,领先于列表中的第二个reStructuredText一个数量级。
今年,多亏了我们去年收到的CZI拨款以及其他社区的努力,尤其地可执行的图书项目,我们投入了大量资源来帮助巩固降价作为Sphinx引人注目的标记语言。
会议上的会谈和研讨会
幸运的是,对大多数项目来说,迁移到MyST-Parser的过程很简单,但我们仍然想传播关于使用MyST Markdown在Read the Docs上创建Sphinx项目的最佳实践。我们设定了在每一次大型科学Python活动上展示的目标,我们所有的提议都被接受了! 2021年全年,我们参加了多项活动:
我们制作了车间材料,欢迎大家使用:
最后,我们还开发了一个交互式web应用程序,用于将少量reStructuredText转换为MyST标记.
未来计划
我们很高兴看到可执行图书团队已发布myst-docutils公司,这应该有助于docutils直接解析CommonMark并可能为斯芬克斯解析Markdown铺平道路无需第三方扩展。希望这也能让狮身人面像更容易在文档中更突出地展示降价内容,用户可以自然地选择标记语言最适合他们的需求,无论是reST还是MyST。
—
考虑在您的下一个狮身人面像、朱庇特书或MkDocs项目中使用Read the Docs?结账我们的文件开始吧!