【问题标题】:Symfony: Generate documentation from markdown with Table of contentsSymfony:使用目录从降价生成文档
【发布时间】:2018-01-12 08:31:58
【问题描述】:

在 Symfony 中生成(工具/服务)文档的最佳实践是什么?

更明确一点:

  • 我想使用 Markdown 编写文档
  • 我可能会有更多不同主题的文件(大约 5-10 个文件),位于一个文件夹中(甚至可能在子文件夹中)
  • 在文档文件中,我希望有其他文档的参考链接
  • 我想从该来源自动生成完整的文档。这应该包含:
    • 目录(带有指向文档文件标题的链接)
    • 生成的 HTML 文件带有所有源文件的单独链接

我已经在网上搜索过,但只找到了那些只能部分满足我需求的库:

任何人有任何想法或已经使用捆绑包?

【问题讨论】:

    标签: php symfony markdown documentation-generation symfony-3.2


    【解决方案1】:

    我为 symfony 使用 phpDocumentor 包:https://symfony.com/projects/phpdocumentor

    【讨论】:

    • 感谢您的链接,但这不是我想要的。我不是在寻找记录我的 php 代码的东西。我想记录我使用 symfony 构建的工具的使用情况。所以它是针对用户而不是开发者的。
    猜你喜欢
    • 2018-09-12
    • 2017-12-26
    • 2012-10-16
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2015-11-05
    • 2022-07-13
    • 1970-01-01
    相关资源
    最近更新 更多