我如何从Markdown中生成文档,并使用双括号引用到其他Markdown [黑曜石,Sphinx]?

发布于 2025-02-09 02:25:41 字数 268 浏览 0 评论 0原文

我在版本控制中有一个黑曜石保险库,其中包含大量项目的文档。这些文档具有对其他文档的双括号引用,例如:

有关更多信息,请参见[[Roadmap.md]]。

我希望团队中的任何人都可以托管和访问我的文档,包括可能不想安装黑曜石的非技术人员。 我已经尝试使用Myst-Parser和Pusemonmark的各种配置与Sphinx生成文档,但无法像我希望的那样将交叉引用转换为已构建文档中的链接。

有什么简单的方法可以实现这一目标吗?

I have an Obsidian vault in version control with a bunch of documentation of my project. These documents have double bracket references to other documents, like:

For more information, see [[Roadmap.md]].

I'd like my documentation hosted and accessible to anyone on my team, including nontechnical people who may not want to install Obsidian.
I've tried generating documentation with Sphinx using various configurations of MyST-Parser and Recommonmark, but can't get the cross-references to convert to links in the built docs as I'd hoped.

Is there an easy way to accomplish this?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

冬天旳寂寞 2025-02-16 02:25:41

我也广泛地使用了狮身人面像&黑曜石的各种出版物。我发现它是发布文档的好生态系统。
我最近遇到了同样的问题,所以我尝试了...

您可以通过运行以下操作:pip install-user git+https://github.com/macqgit/sphinx-obsidian.git@main#egg 然后,在sphinx“ conf.py - >扩展

”中,只需用'sphinx_obsidian'替换'myst_parser',然后运行简单的汇编。
“ [[]]'应该很好地编译。

请放纵,因为这是第一次尝试(也是我第一次尝试通过在github上发布帮助;-)。
另外,解决方案并不是那么好,因为Myst-Parser/Markdown-IT实现不允许在狮身好处环境中轻松扩展'MDIT_PY_PLUGINS的功能...

如果有任何麻烦,您可以与我联系...

I'm also extensively using Sphinx & Obsidian for various publications. I find it to be a nice ecosystem for publishing documentation.
I was recently hitting the same problem, so I gave a try...

You can install it by running this: pip install --user git+https://github.com/MacqGit/sphinx-obsidian.git@main#egg=sphinx-obsidian

Then, in the Sphinx "conf.py -> extensions" just replace the 'myst_parser' by 'sphinx_obsidian' and run a simple compilation.
The '[[ ]]' should be nicely compiled.

Please be indulgent as this is a very first attempt (and the first time that I try to lend help by posting on GitHub ;-).
Also, the solution is not that nice because the Myst-Parser/markdown-it implementations do not allow to easily expand the 'mdit_py_plugins' capabilities in the Sphinx environment...

You can get back in touch with me if any trouble...

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文