你可以执行下列命令来创建一篇新文章或者新的页面。
$ idoc new <path> [title]
idoc 命令提供一个简单的命令,生成文档,示例:
$ idoc new introduce/README.md "Hello World" -f
上面示例命令,在默认的 docs
文档文件夹下,创建 introduce
文件夹,并在里面生成了 README.md
文档文件,默认为文档添加了一个 Hello World
的标题。 -f
参数表示如果文档存在直接覆盖文档。
你可以在指定或默认 docs
的文档文件夹下,添加以 .md
为后缀的文本文件,并根据其内容建立文章。idoc 工具将自动根据位置生成 HTML。
文本文档中可以通过注释配置,添加配置来设置一些功能,如隐藏 toc
,添加创建时间等。
<!--idoc:config:
tocs: false
site: 网站名称
-->
通过添加 idoc.chapters.yml
配置,设置默认主题的左侧 SiderBar 章节导航。详细配置说参考 idoc.chapters.yml
文档。