【文件属性】:
文件名称:techdoc:TechDoc是旨在编写技术文档的主题! 设置简便快捷
文件大小:11KB
文件格式:ZIP
更新时间:2021-04-02 06:03:10
CSS
技术文档
关于
TechDoc是Jekyll主题,旨在编写技术文档。 它附带的模板非常少,因此您可以快速开始编写文档。
安装
将此行添加到您的Jekyll网站的Gemfile :
gem "techdoc"
并将此行添加到您的Jekyll网站的_config.yml :
theme : techdoc
然后执行:
$ bundle
或将其自己安装为:
$ gem install techdoc
用法
按照上述说明安装主题之后,可以在/posts文件夹中创建一个新的.markdown文件,立即开始编写技术文档。 该文件应命名为year-month-day-title.markdown ,文件的开头应类似于以下内容:
---
title : <title>
layout : post
---
一旦知道了,就可以开始写了! 在可以找到有关在Markdown中编写内容的快速参考。
【文件预览】:
techdoc-main
----_layouts()
--------post.html(106B)
--------default.html(2KB)
----Gemfile(69B)
----assets()
--------css()
----README.md(2KB)
----techdoc-jekyll-theme.gemspec(735B)
----.gitignore(59B)
----index.markdown(2KB)
----_config.yml(281B)
----_posts()
--------2021-04-01-test-page.markdown(2KB)
--------2021-04-01-using-this-theme.markdown(6KB)