创建站点

在做好前面的准备工作后,现在可以着手定义属于你自己的站点了。

在项目根目录下执行docsite start命令,会在浏览器中自动打开页面。

初始化生成的模板工程默认集成了首页、文档页、博客列表页、博客详情页、社区页及中英文国际化功能。可以按照需求自行添加和删除页面。

添加文档

  • 将对应的.md或者.markdown文件放进docs文件夹下的对应语言目录中,支持多级目录
  • site_config文件夹下的docs.js中配置文档的菜单项

添加博客

  • 将对应的.md或者.markdown文件放进blog文件夹下的对应语言目录中,支持多级目录存放
  • site_config文件夹下的blog.js中配置博客的列表项
    注:

markdown文件均支持在文档顶部自定义元数据,顶部的—-(至少三个-)之间的数据会被认为是元数据,一个key占用一行。目前支持titlekeywordsdescription三个字段,在生成静态HTML时,分别作为页面标签的标题、页面关键字、页面描述,便于搜索引擎更好地收录站点,从而利于SEO。

  1. ---
  2. title: title
  3. keywords: keywords1,keywords2,keywords3
  4. description: some description
  5. ---
  6. your markdown content