Use vs code to write markdown documentation and MARKDOWN syntax

Source: Internet
Author: User

Directory

    1. First install the Vscode tool, as follows: https://code.visualstudio.com/

    2. Install in the VS code extension: Markdown Preview Enhanced This plug-in, the installation is complete reload can take effect

    3. Create a new. md File
      Visual Studio Code Native supports the syntax of highlighting markdown, and you want to edit the preview one at a time, there are two ways:
      3.1. Ctrl + Shift + P bring up the main command box, enter Markdown, should match to several Markdown related commands

      2.2. Press CTRL + K first, then release, then press V again to bring up the live preview box. "To enter the state in English"

      3.3 Click the shortcut icon directly


      You can also right-click on different platform previews in the preview effect's interface, such as preview in browser

      The default open browser is IE browser, you can directly copy the browser address using Chrome browser open

      You can find that previewing the markdown document in the browser has been compiled into an HTML document.

------------------------------------------------------------Appendix Markdown Syntax------------------------------------------------- -----------------------------

VS Code writing documents using Markdown

1. Direct use of HTML tags, you can set text center, font color and other sample color (HTML syntax)
<div align="center" style="color:red">VS Code 使用 markDown 编写文档</div>
2. Title

Note: Keep a space after # (similar to using the H1/H2 label function)

# h1## h2
3. TOC (Generate table of contents according to title)
代码:
4. References
代码1(单行式):    > hello world!代码2(多行式):    > hello world!    > hello world!    > hello world!代码3(多层嵌套):    > aaaaaaaaa    >> bbbbbbbbb    >>> cccccccccc
5. Inline tag (with ' tag code block will become one line ')
代码:标记之外`hello world`标记之外
6. Code block
1. 用```代码```进行包裹代码:    ```    <div>        <div></div>        <div></div>        <div></div>    </div>    ```2. 自定义语法(根据不同的语言配置不同的代码着色)代码:    ```javascript    var num = 0;    for (var i = 0; i < 5; i++) {        num+=i;    }    console.log(num);    ```
7. Insert Link (pending ... )
代码1(内链式):[百度 1](http://www.baidu.com/ ‘百度一下‘)代码2(引用式):待定。。。
8. Insert Picture
代码1(内链式): ![](./01.png ‘描述‘)代码2(引用式): 待定。。。
8. Insert Picture with link
代码1(内链式): [![](.//img/01.png ‘百度‘)](http://www.baidu.com)代码2(引用式): 待定。。。
9. Insert Video
注:Markdown 语法是不支持直接插入视频的普遍的做法是 插入 HTML 的 iframe 框架,通过网站自带的分享功能获取,如果没有可以尝试第二种方法第二是伪造播放界面,实质是插入视频图片,然后通过点击跳转到相关页面代码1注:多数第三方平台不支持插入<iframe>视频    youku    <iframe height=498 width=510 src=‘http://player.youku.com/embed/XMjgzNzM0NTYxNg==‘ frameborder=0 ‘allowfullscreen‘></iframe>代码2[![](./youku2.png)](http://v.youku.com/v_show/id_XMjgzNzM0NTYxNg==.html?spm=a2htv.20009910.contentHolderUnit2.A&from=y1.3-tv-grid-1007-9910.86804.1-2#paction){:target="_blank"}
10. Sequence
代码1(有序):    1. one    2. two    3. three代码2(无序):    * one    * two    * three代码3(序表嵌套):    1. one        1. one-1        2. two-2    2. two        * two-1        * two-2代码4(序表嵌套代码块)    注:换行+两个Tab    * one        var a = 10;     // 与上行保持空行并 递进缩进

Original syntax: https://www.cnblogs.com/shawWey/p/8931697.html

Use vs code to write markdown documentation and MARKDOWN syntax

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.