vscode + markdown写漂亮的README

1.序言

githubgitlab中常需要写漂亮的README,所以需要大家懂得一些markdown的写法.

2.知识点

  • 空格的写法,表示全角空格,表示半角空格,注意后面的分号.
  • 字体加粗,**字**,字两边加 ∗ ∗ ** ,就可以让字体加粗.
  • 字体倾斜,*字*,字两边加 ∗ * ,就可以让字体倾斜.
  • 标题,用#,加的#越多,标题越小.
  • 下划线,用下划线实现下划线.
  • 删除线,用~~删除内容~~,实现删除.
  • 列表,用-.
  • 表格,用|-|-|.
  • 区块,用>.
  • 地址链接,用[名字](www.baidu.com).
  • 公式,用$公式$.
  • 图片,用![图片名称](图片地址).
  • 代码,用``````.

3.详细展示

  • 表格的展示
|内容1|内容2|
|-|-|
|内容3|内容4|
内容1 内容2
内容3 内容4
  • 图片的展示
![fenjing](https://gimg2.baidu.com/image_search/src=http%3A%2F%2Fimg.jj20.com%2Fup%2Fallimg%2F1113%2F032120114622%2F200321114622-4-1200.jpg&refer=http%3A%2F%2Fimg.jj20.com&app=2002&size=f9999,10000&q=a80&n=0&g=0n&fmt=auto?sec=1652344404&t=ff628030564042459fa619b274b204a0)

vscode + markdown写漂亮的README_第1张图片

  • 公式的展示

$x \cdot sigmoid(\beta x)$

x ⋅ s i g m o i d ( β x ) x \cdot sigmoid(\beta x) xsigmoid(βx)

  • 代码的展示
    vscode + markdown写漂亮的README_第2张图片
import sys
print("WLL YYDS!")

4.配合vscode使用

 vscode需要安装一些插件:

  1. markdown all in one
  2. markdown preview enhanced
  3. markmap

 用markmap可以画一些层级图,很好玩。
vscode + markdown写漂亮的README_第3张图片

5.总结

 实用的教程,主要是给她写的。

你可能感兴趣的:(black,science,technology,markdown)