文档编写

元数据

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

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

路径

在编写markdown文档时,难免需要文档之间的相互引用。而相对地址的写法相比于绝对地址,对于站点内文档之间的引用显得更为便捷。

当需要引用其他文档时,引用路径按照在项目目录的相对文件地址即可。

同样的,当需要引用项目内的图片资源,引用路径同样是相对的文件地址,最终会被处理成正确的绝对地址。