返回

docsify搭建一篇有逼格的博客让妈妈也能看懂的markdown指南

前端

作为一名注重逼格的前端开发人员,我们都希望能写出一手高逼格的项目文档,这样才能让用户用得舒心、放心。docsify作为一种静态博客生成器,可以帮助我们快速搭建一个有逼格的博客。

博客搭建的必备条件:

  1. Node.js环境:Node.js是docsify运行的基础环境,需要提前安装好Node.js。
  2. docsify:docsify是一个静态博客生成器,需要使用npm安装。
  3. 文本编辑器:可以使用任何文本编辑器,如VSCode、Sublime Text等。
  4. Markdown语法:Markdown是一种轻量级的标记语言,用于编写格式化的文本,需要掌握基本的Markdown语法。

一、docsify的安装与配置

  1. 安装docsify:
npm install docsify-cli -g
  1. 创建项目:
docsify init my-blog
  1. 进入项目目录:
cd my-blog
  1. 启动docsify:
docsify serve

二、Markdown指南

Markdown是一种轻量级的标记语言,使用纯文本格式编写文档,并可以使用各种符号对文本进行格式化。

1. 标题

标题可以使用井号(#)加数字来表示,数字代表标题的级别,数字越大,标题级别越小。例如:

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

2. 段落

段落使用空行来分隔,段落内的文本自动换行。

3. 列表

列表分为有序列表和无序列表。有序列表使用数字或字母加点来表示,无序列表使用减号(-)或星号(*)来表示。例如:

1. 有序列表项1
2. 有序列表项2
3. 有序列表项3

- 无序列表项1
- 无序列表项2
- 无序列表项3

4. 代码块

代码块使用三个反引号```来表示,代码块内的文本会以代码格式显示。例如:

console.log("Hello, world!");

5. 链接

链接可以使用方括号[]和圆括号()来表示,方括号中的文本是链接的文字,圆括号中的文本是链接的地址。例如:

[百度](https://www.baidu.com)

6. 图片

图片可以使用感叹号(!)和方括号[]来表示,方括号中的文本是图片的地址。例如:

![docsify logo](https://docsify.js.org/logo.png)

7. 表格

表格可以使用管道符(|