OddFar's Notes OddFar's Notes
首页
  • Java-Se

    • Java基础
    • Java面向对象
    • Java常用类
    • Java集合框架
  • Java-Se进阶

    • JUC多线程
  • Java-ee

    • JavaWeb
  • SQL 数据库

    • MySQL
  • NoSQL 数据库

    • Redis
    • ElasticSearch
    • MongoDB
  • 数据库

    • MyBatis
    • MyBatis-Plus
  • Spring

    • Spring
  • 中间件

    • RabbitMQ
  • Git
  • Docker
  • Jenkins
爬虫
  • Campus (opens new window)
  • 校园信息墙 (opens new window)
关于
归档
GitHub (opens new window)
首页
  • Java-Se

    • Java基础
    • Java面向对象
    • Java常用类
    • Java集合框架
  • Java-Se进阶

    • JUC多线程
  • Java-ee

    • JavaWeb
  • SQL 数据库

    • MySQL
  • NoSQL 数据库

    • Redis
    • ElasticSearch
    • MongoDB
  • 数据库

    • MyBatis
    • MyBatis-Plus
  • Spring

    • Spring
  • 中间件

    • RabbitMQ
  • Git
  • Docker
  • Jenkins
爬虫
  • Campus (opens new window)
  • 校园信息墙 (opens new window)
关于
归档
GitHub (opens new window)
  • 关于 - 我

  • 关于 - 本站

    • 文档 - 快速上手
    • 文档 - md文件写作
      • 推荐写作软件
      • 图片要求
      • 文件命名约定
      • 级别说明
    • 文档 - 部署
    • 标题 - 目录生成
    • 标题 - 锚点比较
  • 关于
  • 关于 - 本站
zhiyuan
2021-05-30
目录

文档 - md文件写作

# 推荐写作软件

推荐写 markdown 软件

  1. Typora

    下载即用

  2. vs code

    需要下载 markdown 插件

    里面终端可设置 git bash 终端,方便调试,适合程序员使用

    设置教程:新版本VS Code 终端设置为git bash (opens new window)

# 图片要求

图片地址必须是可在线访问的链接,不能是本地图片

可以用 GitHub+PicGo+jsDelivr 搭建免费图床

如何免费搭建图床,并在markdown中使用教程:https://oddfar.com/archives/91/ (opens new window)

# 文件命名约定

  • 无论是文件还是文件夹,请为其名称添加上正确的正整数序号和.,从00或01开始累计,如01.文件夹、02.文件.md,我们将会按照序号的顺序来决定其在侧边栏当中的顺序。
  • 同一级别目录别内即使只有一个文件或文件夹也要为其加上序号。
  • 文件或文件夹名称中间不能出现多余的点.,如01.我是.名称.md中间出现.将会导致解析错误。

序号只是用于决定先后顺序,并不一定需要连着,如01、02、03...,实际工作中可能会在两个文章中间插入一篇新的文章,因此为了方便可以采用间隔序号10、20、30...,后面如果需要在10和20中间插入一篇新文章,可以给定序号15。

# 级别说明

源目录(一般是docs)底下的级别现在我们称之为一级目录,一级目录的下一级为二级目录,以此类推,最多到四级目录。

  • 一级目录
    1. .vuepress、@pages、_posts、index.md 或 README.md 这些文件(文件夹)不参与数据生成。
    2. 序号非必须。(如一些专栏,可以不用序号)
  • 二级目录
    1. 该级别下可以同时放文件夹和.md文件,但是两者序号要连贯(参考下面的例子中的其他)。
    2. 必须有序号
  • 三级目录
    • (同上)
  • 四级目录
    1. 该级别下只能放.md文件。
    2. 必须有序号

所有级别内至少有一个文件或文件夹。

vdoing主题介绍文档:https://doc.xugaoyi.com/pages/33d574/

在 GitHub 上编辑此页 (opens new window)
最后更新: 2021/08/03, 15:08:00
文档 - 快速上手
文档 - 部署

← 文档 - 快速上手 文档 - 部署→

Theme by Vdoing | Copyright © 2021-2023 oddfar | 冀ICP备20001094号
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式