Writing manuals using markdown

Preface ：

This time mainly introduces the use of markdown Tools , Edit and maintain the product manual . contain ：

        （ One ） install markdown

        （ Two ）markdown Use

        （ 3、 ... and ） install markdown Directory conversion tool

---

（ One ） install markdown

You need to install before you install Visual Studio Code（ abbreviation ：VScode） Tools .

Online disk download link ：https://pan.baidu.com/s/1yP7Y_IPeSg-pIKnG94GhnQ  Extraction code ：rvlm

（ It needs to be emphasized that , There are a lot of software that also supports .md file , Here we use VScode It is for the purpose of following up the manual push To git Version management , It doesn't mean you can only use this software ）

1. open Visual Studio Code Software , Go to the app store ,

Search for ：Markdown Preview Enhanced Installation

Search for ：Markdown PDF Installation

3. Restart after installation VScode The software will be operated again .

（ Two ）Markdown Use

1. adopt VScode Open a folder （ Empty or existing md The directories of the files can ）.

2. Create a new suffix with demo.md Folder , An empty... Will open on the right md file , We can edit .

3. Here we can edit a md The file , After editing, you can click preview .

4. We can md Export to PDF or HTML.

  Did we find , Export to html There is no directory on the left side of the back , This is what we are going to talk about , How to give Markdown Generate side directories ？

（ 3、 ... and ） install markdown Directory conversion tool

1. download node package ： download | Node.js Chinese net

 

2. After downloading , Direct double click ：node-v16.14.0-x64.msi Installation , The installation is simple. I won't go into details here .

3.  install  i5ting_toc

install node ok after , Input cmd Open the terminal , Input ：npm install i5ting_toc -g

i5ting_toc  usage ：

4. transformation html, stay cmd On the input i5ting_toc -f [ Need to convert file name ].md

（ Here, remember to execute , Be sure to switch to md Directory of the same level ！！）

By default, it is generated in the same level directory preview Folder , open preview Under the same name .html File or directly i5ting_toc -o Preview available .

Converted by this tool md5 There will be a side catalogue .

Additional explanation ：markdown Although the operation is simple , But there are some grammar that we need to remember , Here is a free version of markdown Editor --Typora, Inside operation and word almost , After installation, you don't have to remember those cumbersome grammar rules .（ Download address ：https://pan.baidu.com/s/1UfkbitcviD9Dz1ZGv16Q3A  Extraction code ：8q6e）

Hello Test, Today we markdown The introduction to the use of , It is very practical to use it to maintain the user manual and installation guide of the product , Later I will also introduce how to pass git Manage product manuals , Please pay more attention to , finger heart ~