Stellar主题文档系统的使用

前言

一直想要搭建一个完善的知识库，用于记录自己学习的过程以及之后可以方便的查阅，在看到Stellar主题的文档系统后觉得非常符合自己的要求，所以就打算使用Stellar主题搭建一个属于自己的博客并且将自身的知识库融入到文档系统中。

以下是记录本人是如何使用Stellar的文档系统的，如有需要可点击下方链接查看开发者提供的详细教程。

详细教程

建立一个项目

在博客资源文件夹下建立wiki目录，在wiki中可以建立不同的项目，例如建立：Java、Oracle或者游戏教程等等。

以下所有操作均以Java基础项目为例。

在wiki目录下新建java文件夹，在Java文件夹下新建index.md文件。

设置布局模板和项目名称：

1
2
3
4
5

---
layout: wiki  # 使用wiki布局模板
wiki: Java基础 # 这是项目名
title: Java基础 # 这是标题名称
---

建议用这个文件作为项目的主页，并在文件夹内创建其它分页。Stellar 会把同一个项目的所有分页中 order 最小的一页作为项目的主页（其默认值为0）。

此时修改配置文件中左侧侧边栏导航wiki的地址：

1
2
3
4

######## Sidebar ########
sidebar:
  menu:
    wiki: '[btn.wiki](/wiki)'

回到首页点击左侧侧边栏项目会出现以下界面（注意：点进项目wiki后侧边栏的最近更新会变成项目的最近更新内容）：

点击Java基础项目进去后会出现以下界面：

这个时候我们的文档系统的第一个项目就创建好了，下面我们将一点一点将本项目给扩展完善起来。

完善项目信息

在_data目录下创建项目文件projects.yml，以Java基础项目为例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Java基础:
  name: Java基础
  title: Java基础 - 从入门到精通
  subtitle: '万丈高楼平地起 | 一砖一瓦皆根基'
  tags: [知识库]
  cover: true
  logo:
    src: /customize/svg/java.svg
    small: 90px
    large: 120px
  description: Java在企业应用领域中有着广泛的应用，它可以用于开发各种类型的企业应用，如ERP、CRM、OA等。Java的跨平台性使得企业可以在不同的操作系统上运行Java应用程序，这为企业提供了更大的灵活性和可扩展性。
  #repo: user/repo
  comment_title: '有任何指正的地方可以通过评论或者首页侧边栏联系方式告知本人。'
  #giscus:
  #  data-repo: user/repo
  #  data-mapping: 
  #  data-term: 

是否显示封面

项目可以显示一个全屏封面，封面占据一个屏幕的高度，会居中依次显示项目的 logo、标题、描述。开启项目封面方法如下：

1
2
3
4
5
6

Java基础:
  cover: true
  logo:
    src: /customize/svg/java.svg
    small: 90px
    large: 120px

如果 logo 中已经包含了项目标题，可以这样设置不显示项目标题：

1
2

Java基础:
  cover: [logo, description]

项目文档标签

如果您有很多项目，有些项目是有相关性的，可以相同的 tags 值：

1
2

Java基础:
  tags: [知识库]

项目所在github地址

设置了 repo 值就会在侧边栏显示项目仓库的相关链接：

1
2

Java基础:
  #repo: user/repo

项目评论设置

如果希望项目的所有分页使用相同的评论数据，可以在这里覆盖评论配置：

1
2
3
4
5

Java基础:
  #giscus:
  #  data-repo: user/repo
  #  data-mapping: 
  #  data-term: 

隐藏项目

如果您有些项目希望在项目列表中隐藏，可以设置 index 值：

1
2

Java基础:
  index: false

文档排序

一个项目文档的多个分页之间以 order 的值作为排序依据，数字越小越靠前，最小的是项目主页。

侧边栏设置

侧边栏组件

如果您希望自定义某个项目的侧边栏组件，可以设置 sidebar 值：

1
2

Java基础:
  sidebar: [timeline]

对目录树进行分组

如果您的项目文档分页较多，可以对目录树进行分组：

1
2
3
4
5
6

Java基础:
  ...
  sections:
    'Java基本语法': [0, 99]
    'Java面向对象编程': [100, 199]
    'Java高级应用': [200, 299]

左边是显示的标题，右边是 order 的区间，例如某页文档的 order 是 150，那么这页文档将会显示在「日常问题解决方案」这个组中。

指定 wiki 路径

在根目录中添加 wiki_dir 指定 wiki 主页的路径，若不指定路径，在点击返回所有项目时会回到主页而非回到所有项目。

1

wiki_dir: wiki