创建新一篇文档或博客
删除自带的文件
前面完成了所有的配置工作。从这里开始我们就开始要些东西啦!但是我们得先把原来的东西删除。
首先删除 docs\tutorial-basics
文件夹和 docs\tutorial-extras
文件夹。
但是请保留 docs\intro.md
文件。这个文件是必须的,你可以将里面的内容改成你的内容,比如介绍你自己。
创建第一篇文档
在 docs
文件夹创建一个文件夹,比如你希望放置关于 Java
的知识,就可以创建 Java
文件夹。(在这个文件夹下面还可以接着创建文件夹)。
接着,在 Java
文件夹上面右键-新建文件,命名为 01-begin.md
,建议用英文命名,这将决定你的连接的长度。
Markdown 是一种轻量级的标记语言,可用于在纯文本文档中添加格式化元素。它有着 所写即所得
的特点,它使用一种 格式头 来为一篇文档决定关键信息,在恐龙中格式头如下:
---
id: Java-in # ID
title: Java入门 # 标题
tags: # 标签
- 演示
- 开始上手
---
然后你就可以快乐的书写内容啦!
应该使用 Markdown 语法进行书写内容,相关语法不赘述,请参考:恐龙 Markdown 语法
你可以参考 本篇笔记的 Markdown 源文件。
也可以参考下面的示例:
----
title: 创建新一篇文档或博客 # 文章标题
date: 2022-07-24 # 文章修改时间
authors: Chengzihan # 作者昵称
tags: [React,Docusaurus] # Tag标签
---
## 来自 Docusaurus 的问候
你准备好为你的开源项目创建文档网站了吗?
## 标题
会显示在右上方的目录
这样,你的用户不用通读全文就可以知晓这篇文章的主要内容。
## 目录默认只包括 h2 和 h3 标题。
你可以在每个文档或主题配置中设置目录包含的标题层级。
标题会保持恰当的间距,让文章看起来层级清晰。
- 列表将帮助你
- 阐述让用户牢记的关键点
- 你还可以将其嵌套
- 很多次
## 自定义标题 ID {#custom-id}
你可以用 `{#custom-id}` 语法自定义标题 ID。
显示结果如下:
创建你的第一篇博客
博客和文档类似,但是目的不同,博客每一篇单独存在,不存在文件层次关系。它的显示结构如下图所示:
删除掉 blog
文件夹内除了 authors.yml
外的 所有文件。
创建你的作者信息
在 authors.yml
中填写你的个人信息,原文件的记录如下:
endi:
name: Endilie Yacop Sucipto
title: Maintainer of Docusaurus
url: https://github.com/endiliey
image_url: https://github.com/endiliey.png
yangshun:
name: Yangshun Tay
title: Front End Engineer @ Facebook
url: https://github.com/yangshun
image_url: https://github.com/yangshun.png
slorber:
name: Sébastien Lorber
title: Docusaurus maintainer
url: https://sebastienlorber.com
image_url: https://github.com/slorber.png
而你在你只有一个人时,只需要保留第一项,修改如下:
YourName:
name: Cheng Zihan
title: A student.
url: https://github.com/endiliey # Github 仓库地址
image_url: https://github.com/endiliey.png # 头像连接
新建博客
你的博客必须以 时间-名称.md 构成,名称最好是英文。
例如,一个很好的的文件的例子为: 2022-7-12-MyBlog.md
。
这个文件的格式头为:
----
slug: first-blog-post
title: 认识Vue框架
authors: Chengzihan
tags: [Vuejs]
---
这个文件的内用也按照前面的来写。