# 电子书编写指导

这本电子书是采用vuepress架构编写而成,因此需要遵守此框架的编写规范。 此框架编写的电子书可以参考的开源代码:

# 目录结构

根据框架约定,此子项目的目录结构如下:

  • .vuepress: 这里面存放网页的各种自定义信息,通常不需要修改,详情见官网 (opens new window)
  • */assets: 所有的assets文件夹存放某个主题下,文档需要的资源(图片之类的)
    • 如果使用.vuepress/public里的资源则需要使用一些框架语法
    • 举例如下:<img :src="$withBase('/foo.png')" alt="foo">

# 导航跳转

此处的参考链接 (opens new window)

每个文件夹中的README.md以及index.md会被当作一个默认网页,比如以下网页结构:

  • .
    |- A
    |  |- README.md
    |- B
    |  |- README.md
    |  |- one.md
    
  • 那么从B/one.md跳转到A/READMD.md可以直接写成如下格式:

    • [描述](/A/)
    • [描述](/A/README.md)
    • [描述](../A/README.md)
Last Updated: 2/19/2023, 6:04:44 PM