我有一个项目,它在src
目录之外有很多有用的文档,我想像往常一样呈现DocPad文档。
示例:
README.md
、LICENSE
、Contributing.md
和类似的文件,这些文件已经存在,可以用于GitHub之类的东西。我希望重用这些文件中的内容,以创建相应的readme
、license
和contributing
页面,或者将这些文件的内容包含在布局或文档中的某个位置。.md
文件包含在package.json
中,从而将它呈现为DocPad文档,这样这些文件就在根目录下的node_modules
中了。在这两种情况下,我都希望将src/documents
之外的文件作为部分或文档使用,而且部分插件似乎无法帮助我(或者我无法找到一种方法使它满足我的需要),而@getCollection
只能从src/documents
获得东西。
因此,问题是:我是否可以告诉DocPad从src
文件夹外部处理一些文件/文件夹?我错过了什么吗?
如果没有,那么作为插件的最佳方法是什么,我应该挖哪个方向呢?
发布于 2014-08-24 13:30:30
答案将是相当简单的:相对符号链接。Docpad处理得很好。
这样,要在文档中有一个README.md的符号链接,就应该这样做(使用src/ pwd
的pwd
):
ln -s ../../README.md readme.html.md
或者,如果文档来自项目的一个模块内:
ln -s ../../node_modules/foobar/docs/ docs
这两种变体都工作得很好。
注意:Symlink可能很棘手。关于一些常见的问题,请参考以下内容:
发布于 2016-01-05 00:13:17
DocPad本机支持将文档存储在默认的src
文件夹之外。您这样做的方式是通过DocPad配置文件中的DocPad配置文件配置选项(例如docpad.coffee
)。就像这样:
path = require('path')
docpadConfig = {
documentsPaths: [
'documents'
path.resolve('..','data','documents')
]
....
当然,如果您只想在文件系统的某个位置包含任意的单独的文件,那么这个结果就会下降。在这种情况下,符号链接将是最好的选择。
发布于 2016-01-05 13:15:57
模板助手也可以用于此,因为他们可以做任何你想做的事。
例如,贝弗里学习中心网站使用模板帮助器通过相对路径呈现任意文件,作为代码示例:
如果您也希望呈现它们,则可以将此解决方案与文本插件结合使用。
这种组合应该是这样的:
https://stackoverflow.com/questions/24510543
复制相似问题