叶状文档生成器的扩展,用于从多个源生成文档。
foliantcontrib.multiproject的Python项目详细描述
#多项目扩展
multiproject是folant从多个来源生成文档的扩展。多项目由三部分组成:
*扩展"foliant.config"包来解析!从'yaml tag;
*src'命令的cli扩展;
*repolink预处理器。
从"tag
这个扩展解析了"!从项目配置中的"yaml tag",并用相关子项目的"chaptres"部分替换标记的值。
\或者另一个引用)。
project config中的"chapters"部分示例:
``yaml
章节:
-index.md
-!从本地目录
-!从https://github.com/foliant docs/docs.git
-!从https://github.com/some_other_group/some_other_repo.git development
````
superproject(通常称为"src")。
注意,foliant允许使用"-config"或"-c"命令行选项覆盖默认配置文件名"foliant.yml"。提供多项目扩建的正确工作,超级项目和所有子项目中都应使用相同的配置文件名。
\src命令的cli扩展名
备份。
需要备份源目录,因为多项目扩展通过将生成的子项目的目录移动到其中来修改此目录。
使用以下命令:
``bash
$foliant src backup
````
默认情况下,使用名称"foliant.yml":
``bash
$foliant src backup--config alternative_config.yml
```
如果未指定,将使用当前目录。
\repolink preprocessor
此预处理器允许向每个标记源添加指向Git存储库中相关文件的超链接。超链接出现在文档的第一个标题之后。
预处理器模拟mkdocs行为,并支持与mkdocs相同的选项"repo-url"和"edit-uri"。将预处理器应用于子项目允许从单个站点(或单个mkdocs项目)的不同页面获取到单独存储库的链接。
将"repolink"添加到项目配置中的"preprocessors"部分:
``yaml
预处理器:
-repolink
````
>预处理器有许多选项:
``yaml
预处理器:
-repolink:
repo url:https://github.com/foliant docs/docs/
编辑uri:/blob/master/src/
链接文本:"&;xe3c9;"
链接标题:查看源文件
链接HTML属性:"类=\"MD图标MD-content图标"样式=\"边距:-7.5rem 0"
目标:
-pre
````
`repo URL`
:相关存储库的URL。默认值为空字符串;在这种情况下,预处理器不适用。TR错误的斜杠不影响。
`edit_uri`
:存储库中每个文件的url中与修订相关的部分。默认值是`/blob/master/src/`。前导斜杠和尾随斜杠不影响。
`链接文本`
:超链接文本。默认值为"编辑此页"。
"链接标题"
:超链接标题("标题"html属性的值)。默认值也是"编辑此页"。
"链接HTML属性"
:超链接的其他HTML属性。通过将css与"class"属性和/或"style"属性结合使用,您可以自定义超链接的表示形式。默认值为空字符串。
`targets`
:预处理器允许的目标。如果未指定(默认情况下),预处理器将应用于所有目标。
它在一些不稳定的测试或准备环境中非常有用。
multiproject是folant从多个来源生成文档的扩展。多项目由三部分组成:
*扩展"foliant.config"包来解析!从'yaml tag;
*src'命令的cli扩展;
*repolink预处理器。
从"tag
这个扩展解析了"!从项目配置中的"yaml tag",并用相关子项目的"chaptres"部分替换标记的值。
\或者另一个引用)。
project config中的"chapters"部分示例:
``yaml
章节:
-index.md
-!从本地目录
-!从https://github.com/foliant docs/docs.git
-!从https://github.com/some_other_group/some_other_repo.git development
````
superproject(通常称为"src")。
注意,foliant允许使用"-config"或"-c"命令行选项覆盖默认配置文件名"foliant.yml"。提供多项目扩建的正确工作,超级项目和所有子项目中都应使用相同的配置文件名。
\src命令的cli扩展名
备份。
需要备份源目录,因为多项目扩展通过将生成的子项目的目录移动到其中来修改此目录。
使用以下命令:
``bash
$foliant src backup
````
默认情况下,使用名称"foliant.yml":
``bash
$foliant src backup--config alternative_config.yml
```
如果未指定,将使用当前目录。
\repolink preprocessor
此预处理器允许向每个标记源添加指向Git存储库中相关文件的超链接。超链接出现在文档的第一个标题之后。
预处理器模拟mkdocs行为,并支持与mkdocs相同的选项"repo-url"和"edit-uri"。将预处理器应用于子项目允许从单个站点(或单个mkdocs项目)的不同页面获取到单独存储库的链接。
将"repolink"添加到项目配置中的"preprocessors"部分:
``yaml
预处理器:
-repolink
````
>预处理器有许多选项:
``yaml
预处理器:
-repolink:
repo url:https://github.com/foliant docs/docs/
编辑uri:/blob/master/src/
链接文本:"&;xe3c9;"
链接标题:查看源文件
链接HTML属性:"类=\"MD图标MD-content图标"样式=\"边距:-7.5rem 0"
目标:
-pre
````
`repo URL`
:相关存储库的URL。默认值为空字符串;在这种情况下,预处理器不适用。TR错误的斜杠不影响。
`edit_uri`
:存储库中每个文件的url中与修订相关的部分。默认值是`/blob/master/src/`。前导斜杠和尾随斜杠不影响。
`链接文本`
:超链接文本。默认值为"编辑此页"。
"链接标题"
:超链接标题("标题"html属性的值)。默认值也是"编辑此页"。
"链接HTML属性"
:超链接的其他HTML属性。通过将css与"class"属性和/或"style"属性结合使用,您可以自定义超链接的表示形式。默认值为空字符串。
`targets`
:预处理器允许的目标。如果未指定(默认情况下),预处理器将应用于所有目标。
它在一些不稳定的测试或准备环境中非常有用。