mirror of
https://github.com/pengzhanbo/vuepress-theme-plume.git
synced 2026-04-23 10:58:13 +08:00
52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
---
|
|
title: 编写文章
|
|
author: Plume Theme
|
|
createTime: 2024/03/04 10:06:06
|
|
permalink: /guide/write/
|
|
---
|
|
|
|
|
|
::: info 提示
|
|
以下内容中，以 `sourceDir` 表示 项目中用于保存 `Markdown` 文件的目录。
|
|
|
|
如 `package.json`的`scripts` 中配置的 `vuepress dev src`，则表示 `sourceDir` 为 `src` 目录
|
|
:::
|
|
|
|
## 约定
|
|
|
|
使用本主题编写文章是一件很轻松的事情，你可以在 `sourceDir`目录中按照你的个人命名喜好新建任意名字的`Markdown`文件，
|
|
主题将会自动帮你生成一个文章永久链接，并保存在文章的配置中，以便随时修改。
|
|
|
|
对于 `sourceDir` 中的文件夹命名，主题有一套简单的约定。
|
|
|
|
- 文件夹的名称将作为 `category` 即 __分类__。
|
|
- 允许多级目录，子级目录将作为父目录对应的分类的子项。
|
|
- 如果目录名称 在 [主题配置 notes](/vuepress-theme-plume/theme-config/#notes) 中声明用于 notes 文章管理，则默认不作为 分类目录。
|
|
|
|
### 文件夹命名约定
|
|
|
|
由于文件夹名称将作为分类名称，且不在主题配置中进行排序配置，对于有排序需要的场景，使用以下规则进行命名
|
|
``` ts
|
|
const dir = /\d+\.[^]+/
|
|
// 即 数字 + . + 分类名称
|
|
// 如： 1.前端
|
|
```
|
|
数字将作为 __排序__ 的依据。 如果不带数字，则以默认的规则进行排序。
|
|
|
|
__example:__
|
|
``` txt
|
|
.{sourceDir}
|
|
- 1.前端
|
|
- 1.html
|
|
- 2.css
|
|
- 3.javascript
|
|
- 2.后端
|
|
- 运维
|
|
```
|
|
|
|
|
|
## 文章写作
|
|
|
|
你可以使用 `markdown` 语法开始在 `sourceDir` 下新建 `Markdown` 文件，编写你自己的文章了，
|
|
关于 markdown 扩展的功能支持，请查看 [这个文档](/guide/markdown/)。
|