使用vuepress写项目帮助文档

简介: vuepress 官网 vuepress 是使用vue驱动的静态网站生成器,与Docsify 不一样的是编译它后是静态网页可以直接拷贝到其它项目中使用。 目录结构 docs:用于存储markdown文件 docs.

vuepress 官网

vuepress 是使用vue驱动的静态网站生成器,与Docsify 不一样的是编译它后是静态网页可以直接拷贝到其它项目中使用。

目录结构

5e171524_e8c8_4604_b59b_d8f2dbc67261

  • docs:用于存储markdown文件
  • docs.vuepress:用于存储vuepress配置文件,样式,以及公共文件
  • docsdemo:非固定名称,存储markdown的二级目录,可以有多个
  • docsimages:非固定名称,存储markdown中使用的图片,不能放到二级目录中否则编译中会被忽略
  • docsREADME.md : 文档首页,加入部分特殊语法的markdown
    README特殊部分如下,其它的随意。

actionLink:点击按钮后进入的页面。

---
home: true
heroImage: 
actionText: 快速开始 →
actionLink: /demo/test1/
features:
- title:title1
  details: details1
- title: title2
  details: details2
- title: title3
  details: details3
footer: MIT Licensed | Copyright © 2019-d
--- 

配置说明

重要配置说明:

  • dest :输出的目录地址可以使用相对路径
  • base:部署站点的基础路径,如果你想让你的网站部署到一个子路径下,你将需要设置它。如 GitHub pages,如果你想将你的网站部署到 https://foo.github.io/bar/,那么 base 应该被设置成 "/bar/",它的值应当总是以斜杠开始,并以斜杠结束。
  • plugins: 使用的插件,需要先安装
  • themeConfig-sidebar:侧边栏目录,使用/结束时默认找此目录下的README.md 文件,否则使用名称+.md为结尾,编译后会使用文件中一级目录作为侧边栏目录名称
module.exports = {
 title: 'test title',
 description: 'test description',
 head: [
  ['link', { rel: 'icon', href: '/favicon.ico' }]
 ],
 dest: '../static/helpDoc', // 设置输出目录
 // 注入到当前页面的 HTML <head> 中的标签
 base: '/Demo/helpDoc/',
 markdown: {
  lineNumbers: true // 代码块显示行号
 },
 plugins: [
    'flowchart'
 ],
 themeConfig: {
  lastUpdated: 'Last Updated', // 文档更新时间
  // 侧边栏配置
  sidebar: [{
    "children": [
     "/demo/test1",
     "/demo/test2"
    ],
    "collapsable": true,
    "title": "demo"
   }
  ]
 }
} 

自定义样式

index.styl :设置自定义样式覆盖原有样式
palette.styl :全局样式设置,主要是设置颜色

碰到的问题

  • 图片不能放在二级目录中,否则构建的时候会忽略。
目录
相关文章
|
Java 数据安全/隐私保护
在线预览项目kkFileView(二)代码讲解与修改
在线预览项目kkFileView(二)代码讲解与修改
953 0
在线预览项目kkFileView(二)代码讲解与修改
|
3月前
|
JavaScript
文档工具GitBook使用指南
这篇博客提供了GitBook的安装和使用指南,包括如何在本地安装Node.js和GitBook、初始化GitBook项目、生成HTML和电子书格式(PDF、mobi)的文档,以及推荐的相关阅读资源。
96 8
文档工具GitBook使用指南
|
资源调度 JavaScript 应用服务中间件
VuePress介绍及使用指南
VuePress是一个基于Vue.js的静态网站生成工具,它专注于以Markdown为中心的项目文档。VuePress具有简单易用的特性,同时提供了强大的自定义和扩展性。
185 2
VuePress介绍及使用指南
|
网络安全 开发工具 git
使用vercel快速部署vuepress-next项目
使用vercel快速部署vuepress-next项目
|
机器人
gitbook 插件 阅读更多
gitbook 插件 阅读更多
|
弹性计算 JSON JavaScript
安装 VuePress | 学习笔记
快速学习安装 VuePress。
|
XML JSON JavaScript
在线预览项目kkFileView(一)项目搭建与使用
由于项目需要在线预览 开始想自己实现 如上文 但是也想弄一份html格式的 但是格式总是达不到理想 所以使用了 kkFileView
922 1
在线预览项目kkFileView(一)项目搭建与使用
|
资源调度 JavaScript 前端开发
从零实现一个 VuePress 插件
在搭建 VuePress 博客的过程中,也并不是所有的插件都能满足需求,所以本篇我们以实现一个代码复制插件为例,教大家如何从零实现一个 VuePress 插件。
289 0
从零实现一个 VuePress 插件
|
资源调度 前端开发 JavaScript
使用脚手架新建一个插件 | VSCode 插件开发系列教程
其实VSCode的插件也是由Javascript开发的,各位前端开发者们想不想试着自己开发一款插件呢?
324 0
使用脚手架新建一个插件 | VSCode 插件开发系列教程