美文网首页
用户手册书写教程

用户手册书写教程

作者: 韩_小文 | 来源:发表于2018-10-25 16:14 被阅读0次

    准备工作

    安装vscode

    image.png image.png

    任意文件夹即可,创建README.md文件,开始书写markdown。

    右上角左侧第一个按钮开启同步预览功能。


    image.png
    image.png

    暂时需要用到的markdown语法

    标题

    在想要设置为标题的文字前面加#来表示(在#后跟个空格再写文字)
    一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。

    示例:

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

    效果如下:

    这是一级标题

    这是二级标题

    这是三级标题

    这是四级标题

    这是五级标题
    这是六级标题

    图片

    语法:

    ![图片alt](图片地址 ''图片title'')
    
    图片alt就是图片加载中或者加载失败时显示的文字,相当于对图片内容的解释。
    图片title是图片的标题,当鼠标移到图片上时显示的内容。title可加可不加,两者最好一样,简单省事儿
    

    示例:


    image.png

    鼠标移到图片上时出现


    image.png image.png

    确保.md文件跟图片文件位于同一文件夹下,按上述写法,即可。


    image.png

    请注意相关图片的命名!!!例子如上图所示,灰常重要,方便后期的维护!!!有任何随意命名以求效率者,一张图片五块钱请自觉转账到大兄弟的微信收款账号下,谢谢
    ———《仲贤语录》

    注意

    所有文件开头处需要加上固定的代码

    # 注册和登录
    
    <ClientOnly>
      <CMediumZoom/>
    </ClientOnly>
    
    ## 注册
    

    其中 注册和登录 替换为相应的顶级标题

    一级标题后跟二级标题,以此类推。

    如需了解更多语法,参照此处markdown语法

    相关文章

      网友评论

          本文标题:用户手册书写教程

          本文链接:https://www.haomeiwen.com/subject/nuhctqtx.html