玉龙视觉效果工作室

一个属于自己的天地 : 玉龙视效工作室

ERON VISUAL STUDIO (EVS)

关于

才疏学浅, 贻笑大方

我自己

About Me

主要项目

开始

十步杀一人, 千里不留行. 事了拂衣去, 深藏身与名

文档头

一般一个父级路径下包含多个子文档, 形成多级菜单

位于docs路径下, 创建子文件夹, 然后设置一个顶级目录, 其余作为顶级目录的子文档

父级目录文档头

---
title: Utilities  # 显示当前目录名称
layout: default  # 布局, post, about, home, default ...
nav_order: 4  # 在目录中的显示位置
has_children: true  # 表示是否有子文档/目录 
permalink: docs/about  # 请求路径
---

中间级目录文档头

---
title: A minimal layout page  # 名称
layout: minimal  # 布局
parent: Layout  # 父级名称, 即 父级 title的名字
has_children: true  # 是否有子目录 
---

子目录文档头

---
title: Minimal layout child page  # 文章显示名
layout: minimal  # 布局设置
parent: A minimal layout page  # 父级目录 title
grand_parent: Layout  # 上上级路径 
---

布局设置

just-the-doc 提供了基于jekyll的布局使用, 当前有以下几个布局的样式 :

  • default
  • minimal
  • about
  • home
  • page
  • post

绘图工具

Github支持的绘图 : Write On Github

mermaid绘图工具的使用 : Mermaid Start

数学公式

Latex : Latex
mathjax Web数学公式渲染引擎 : mathjax

搜索整理

因为使用中文无法提供搜索, 所以使用分类标签实现每个文档的类别标记, 方便查找
每一个文档大标题下面增加Label标示, 后期可以根据Label标签快速搜索和整理

demo label …

custome label
{: .label .label-blue}

others colors
.label-green .label-purple .label-yellow .label-red

特殊使用

  • 引用相对路径文件时, 不带后缀, 如直接使用docs前路径下的summary.md文件, 即./docs/summary 这样使用路径即可