文档结构

在本节中,我们将阐述 Daymd 中文档的结构。以便让你清楚创建什么样的结构能够在网站上展示什么样的结果。

#结构树

你一定在前面已经见过了下面的结构:

├── content
│   ├── docs
│   │    ├── index.md
│   │    ├── 000-doc1
│   │    │   ├── index.md
│   │    │   ├── 000-doc11.md
│   │    │   └── 001-doc12.md
│   │    └── 002-doc2
│   │        ├── index.md
│   │        ├── 000-doc11.md
│   │        └── 001-doc12.md
│   └── posts
│        ├── index.md
│        ├── 000-post1
│        │   └── index.md
│        └── 002-post2
│            └── index.md
...

正如你看到的,content 文件夹下被分为了 docsposts 两个文件夹。它们分别用来存放你的文档博客。现在让我们聚焦于文档,在文档中,你可以创建多个集合,每个集合是一个文件夹,每个集合中可以创建多个文件,每一个文件是一个 Markdown 文件也就是一篇文章。

#创建第一个集合

在你的个人知识体系中,你可能要存放不同知识领域的东西,这也就要求创建多个集合,每个集合有不同的主题,比如 JavaC++Python 等等。而在这些主题下都各自对应多篇文章。你可能想构造下面这样的知识体系:

├── docs
│    ├── index.md // 文档首页
│    ├── 000-Java
│    │   ├── index.md // Java 集合首页
│    │   ├── 000-语法.md // Java 第一篇文章
│    │   └── 001-网络编程.md // Java 第二篇文章
│    └── 002-Python
│        ├── index.md   // Python 集合首页
│        ├── 000-语法.md   // Python 第一篇文章 
│        └── 001-爬虫.md    // Python 第二篇文章

这里面就包括了两个集合,因此你需要在 docs 文件夹下再创建两个文件夹,名称分别为 000-Java002-Python

现在,我们创建第一个文件夹,名称为 000-Java,然后在这个文件夹下创建两个文件,名称分别为 000-javalanguage.md001-javaweb.md。如下图:

1

注意
在项目中,由于要生成链接,因此您的文件名需要使用英文小写字母构成

不过,在没有内容的情况下,项目很可能无法运行,让我们先简单填充一下,过后再讲解。

index.md
---
title: Java
excerpt: 快速上手
date: 2022-08-25
---
## Java
Java语法.md
---
title: Java语法
excerpt: 快速上手
date: 2022-08-25
---
## Java
Java网络编程.md
---
title: Java网络编程
excerpt: 快速上手
date: 2022-08-25
---

按下 ctrl+s 保存文件,可以看到右边的执行窗口开始刷新,等待刷新完成。
刷新完成后,如下:

1

用相同的操作,你可以创建多个文档集合。

#创建第一个文档

在上面创建了第一个集合之后,我们就可以创建第一个文档啦!让我们看看一篇标准的文档有什么构成。让我们来思考,我们如何告诉 Daymd 这篇文章的内容,如 标题简介创建日期等信息,答案是使用格式头。格式头是一种 yml 语法,它是一种轻量级的配置文件,可以用来存放一些配置信息。在 Daymd 文档中,我们使用 yml 来存放一些配置信息,比如 titleexcerptdate 等等。它放在 Markdown 的头部。

一个格式头必须用 --- 进行包裹,与主要内容区分开。每一篇文档有且仅有一个格式头。

---
title: 文档标题
excerpt: 文档简介
date: 2022-8-25 # 文档创建时间
---
## 下面是文档主要内容

title被渲染在页面头部,而 excerpt 并不会被渲染到页面,date被渲染在页面底部。

1

下面是一个较完整的文档例子,其标题是 Java , 描述是 Java Note, 创建日期是 2020-8-25,主要内容是从 # Java 开始的下面那些内容:

---
title: Java
excerpt: Java Note
date: 2022-8-25
---
 
## Java
Java 是由 Sun Microsystems 公司于 1995 年 5 月推出的高级程序设计语言。
Java 可运行于多个平台,如 Windows, Mac OS 及其他多种 UNIX 版本的系统。
本教程通过简单的实例将让大家更好的了解 Java 编程语言。
移动操作系统 Android 大部分的代码采用 Java 编程语言编程。
 
 
 
## Java Examples
 
以上我们使用了两个命令 javac 和 java。
javac 后面跟着的是java文件的文件名,例如 HelloWorld.java。 该命令用于将 java 源文件编译为 class 字节码文件,如: javac HelloWorld.java。
运行javac命令后,如果成功编译没有错误的话,会出现一个 HelloWorld.class 的文件。
java 后面跟着的是java文件中的类名,例如 HelloWorld 就是类名,如: java HelloWorld。

当你完成一篇内容的编辑后,进行保存, Daymd 会自动解析你的文档内容并生成静态页面,上面的文档解析结果如下,文档使用的 Markdown 语法特性将在后面的章节中讲述。

2

提示
遇到问题?
如需要帮助,可以选择给电子邮箱发邮件: czhorange@foxmail.com 或者点击进入 issue 提交界面.
Last Updated:2022-08-29
文档地址