- html - 出于某种原因,IE8 对我的 Sass 文件中继承的 html5 CSS 不友好?
- JMeter 在响应断言中使用 span 标签的问题
- html - 在 :hover and :active? 上具有不同效果的 CSS 动画
- html - 相对于居中的 html 内容固定的 CSS 重复背景?
我们正在考虑使用 Asciidoc 来创建用户指南,我们打算只在 github 上对单个文件进行版本控制。
然而,我们看到,像 ProGit ( https://github.com/progit/progit2/tree/master/book ) 这样的已建立项目虽然也生成单个文档,但将 Asciidoc 拆分为多个文件。
将一个逻辑文档拆分成多个文件有什么好处?
最佳答案
我认为使用多个文档的最大优势在于组织和精神上。假设您有每个部分的文档,如果它在自己的文档中,则查找和修复或添加到一个部分要容易得多。当您打开较小的文档时,与打开较大的文档相比,它也更容易在精神上消耗和思考。如果您打开一个文档并且滚动条开始变得越来越小,您就会开始考虑需要多长时间才能找到您需要更改的内容、是否值得进行更改以及加载需要多长时间。当然这些都是主观的,也许有些人没有这个问题。
使用多个文档的另一个很好的理由是,如果在将来的某个时候您决定拆分每个部分/章节,那么从多个文档开始并将它们包含在一个大文档中比之后尝试将其切碎更容易。
除了组织问题之外,如果您有多个人在处理一个文档,那么与一个大文档相比,在一个较小的文档中更容易看到更改。
关于asciidoc - 对一个 AsciiDoc 文档使用多个文件有什么好处?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/27945510/
似乎没有办法在 Asciidoc 的文字文本中解析变量(属性、替换),否则我会遗漏一些东西。我希望能够设置一个变量,然后在代码块或文字字符串中调用它,如下所示: :version: 1.0.1 [co
您好,我想将“自动生成”的行号添加到 asciidoc 文件的表中。我有这样的东西。 .Sample Table [cols=2, options="header"] |=== |ID | Descr
我正在使用 spring rest docs 生成 asciidoc 片段。 我可以在我的文档页面中包含生成的片段。但是,我想在单独的 adoc 文件中定义每个部分的结构一次,并在我的索引文件中为每个
我正在使用 Spring RestDoc 和 AsciiDoc 来描述我的 rest api。 RestDoc 根据是否有描述的请求参数/响应字段等生成不同的文件。我希望有一个模板有条件地包括任何存在
Asciidoc :toc:命令从文档中的标题创建一个格式良好的目录: :toc: = Part 1 = Part 2 = Part 3 但我希望我的目录链接到其他文档,而不是从文档本身中提取: li
我正在使用 asciidoc 和 asciidoctor 编写文档。所以,我有一个 intro.adoc 文件,然后是一堆节文件。所以,我想要做的是将它们列出到 intro.adoc 并为它们添加超链
我们正在考虑使用 Asciidoc 来创建用户指南,我们打算只在 github 上对单个文件进行版本控制。 然而,我们看到,像 ProGit ( https://github.com/progit/p
我插入了一个块图像,如下所示: [[myimage]] image::fig1.png[align="center", title="My caption"] 不幸的是,图像居中,但标题左对齐。我也试
上下文 我正在制作一个脚本,它在 AsciiDoc 文件的代码块中动态插入 include 指令,然后从中生成 PDF。生成的 AsciiDoc 文件可能如下所示: = Title [source,j
我经常在我的 asciidoc 中使用代码块。我遇到的最大问题是以“#”开头的 shell 命令(因为它们使用 root 的 shell)在 asciidoc 中呈现为注释。例如: [source,s
例如,如果我写: Notepad++ is *great*, I like Notepad++ 它将 ++something++ 视为一个转义结构,它忽略了 * 粗体并产生: Notepad is *
如何在 adoc 文件中呈现删除线(或换行)? 假设我想写“该技术 -c-r-a-p- 并不完美。” 最佳答案 That technology is [line-through]#crap# not
我试图转换我的 mybook.adoc至 mybook.pdf使用 pandoc ,并得到以下错误。 $ pandoc -s mybook.adoc -t asciidoc -o mybook.pdf
考虑到 DocBook 格式的书可以以“模块化”的方式完成,我希望我可以用 AsciiDoc 做类似的事情,并将章节和第一级部分拆分到单独的文件中。不幸的是,文档没有提及这一点。到目前为止,我看到的唯
在 Markdown 我可以写: [example1][myid] [example2][myid] [myid]: http://example.com 所以我不必多次重新输入完整的外部链接。
reStructuredText 允许您扩展/重写 writer 的标记。因此,您可以通过定义的 API 添加新类型的嵌入式对象或引入新的子语言。 Asciidoc(原始 Python 实现或 Rub
例如,我想添加 loading="lazy" 归因于我的所有图像,例如: image::myimage.jpg[] 但默认 HTML 元素输出没有那个属性。 也许这是在:Creating custom
我想找到一种方法在我的 Asciidoc 文档的目录中隐藏某些标题,我正在使用 Asciidoctor 将其处理为 HTML 和 PDF。 我增加了headerlevel值以包含一些其他子标题,但这样
我正在使用 asciidoc 标记语言编写文档并将其推送到 github 存储库。 Github 会自动呈现 asciidoc 文件 (*.adoc),但出于(我)不明原因不想接受我嵌入的 youtu
我将org.asciidoctor.convert插件用于gradle来为我的团队生成API文档。我包含文件: include::{snippets}/index/curl-request.adoc[
我是一名优秀的程序员,十分优秀!