一直想找一个系统架构和设计都足够干净的系统

前提

理论上任何工具写出来的 markdown(下文简称 md)文件都能用,但是如果是按照以下方式写的话,可能表现力会丰富很多

查看环境

假设你是 mac?!

  • 安装 brew 这个可以装很多东西,正常是网上搜一句命令就装了
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  • 安装 node ,有 brew 的情况下, 就是 brew info node 一句话就行了
brew info node
  • 安装 vitepress 本文重点 前两个都有都情况下 一句话就行了 npm install -g vitepress
npm install -g vitepress

到你的 md 目录执行 vitepress dev . 就能查看文档大致的样子

vitepress-markdown 特性

表格

TablesAreCool
col 3 isright-aligned$1600
col 2 iscentered$12
zebra stripesare neat$1

提示

::: tip
This is a tip
:::

::: warning
This is a warning
:::

::: danger what??
This is a dangerous warning
:::

TIP

This is a tip

WARNING

This is a warning

what??

This is a dangerous warning

代码高亮

export default {
  name: 'MyComponent'
  // ...
}

emoji 表情

:tada: :100:

🎉 💯

规范与建议

便于效果一致,目前发现页面标题从 ## h2 开始使用可以获得最佳展示效果