How To Use

内容编辑

如何编辑文档内容

把我们的内容放在 content 目录下,而我们的程序会自动解析这些内容,并渲染到我们的网页上。

目录和路径映射

文件内部路径
content/index.md/
content/about.md/about
content/blog/index.md/blog
content/blog/hello.md/blog/hello
content/1.guide/2.installation/guide/installation

手动排序

添加数字前缀,可以指定文件的顺序。

Directory structure
content/
  1.frameworks/
    1.vue.md
    2.nuxt.md
  2.examples/
    1.vercel.md
    2.netlify.md
    3.heroku.md
    index.md

隐藏内容

任何以 . 开头的文件或目录,都会被隐藏。

Directory structure
content/
  1.frameworks/
    .1.vue.md              // Ignored content
    2.nuxt.md
  .2.translation/          // Ignored directory
    1.fa/
      1.messages.md        // Ignored content because of its grand parent
    2.fr/
      1.messages.md        // Ignored content because of its grand parent

片段内容

添加 _ 前缀的文件,会被标记为片段内容。

片段内容可以在搜索和内容列表中访问,但不会在内容导航中显示。

Directory structure
content/
  1.frameworks/
    _1.vue.md              // Partial content
    2.nuxt.md
  _2.translation/          // Partial directory
    1.fa/
      1.messages.md        // Partial content because of its grand parent
    2.fr/
      1.messages.md        // Partial content because of its grand parent

Copyright © 2025