zoukankan      html  css  js  c++  java
  • 快速创建vuepress项目(使用vuepress写文档)

    vuepress的官方文档:https://vuepress.vuejs.org/zh/guide/

    参考:
    https://segmentfault.com/a/1190000016333850

    https://juejin.im/post/5d1f1136f265da1ba77cc3d3

    https://juejin.im/post/5d1ab9c151882579dd60d5e0

    视频教程:https://www.bilibili.com/video/av78052346?p=2

    搭建一个vuepress项目

    项目初始化

    1、创建一个文件夹

    2、项目初始化

    npm init

    安装配置VuePress

    1、进入创建的文件夹

    2、在文件夹目录下安装VuePress

    npm install -D vuepress

    3、新建文件夹,并命名为docs

    4、创建一个Markdown文件

    echo "# Hello VuePress!" > docs/README.md

    5、启动预览

    npx vuepress dev docs

    如果使用vscode,则根据控制台提供的地址进行访问

    6、配置package.json

    {
      "scripts": {
        "docs:dev": "vuepress dev docs",
        "docs:build": "vuepress build docs"
      }
    }

    7、更换启动命令,再次启动,查看是否配置成功

    npm run docs:dev

    编写文档

    1、配置主页

    ---
    home: true
    heroImage: /flypig.gif
    heroText: 中药溯源系统
    tagline: 接口文档
    actionText: 快速上手 →
    actionLink: /guide/
    features:
    - title: 简洁至上
      details: 以 Markdown 为中心的项目结构,以最少的配置帮助你专注于写作。
    - title: Vue驱动
      details: 享受 Vue + webpack 的开发体验,在 Markdown 中使用 Vue 组件,同时可以使用 Vue 来开发自定义主题。
    - title: 高性能
      details: VuePress 为每个页面预渲染生成静态的 HTML,同时在页面被加载的时候,将作为 SPA 运行。
    footer: 中药溯源接口文档1.0 | Copyright © 2019 flypig
    ---

    2、在docs文件夹下创建.vuepress文件夹,并在.vuepress下创建config.js和public文件夹,public文件夹下放图片等静态文件

    我的config.js的配置

    module.exports = ctx => ({
        title: 'xxxxxx文档',
        head: [['link', { rel: 'icon', href: '/logo.ico' }]],
        description: 'Just playing around',
        theme: '@vuepress/theme-default',
        themeConfig: {
            nav: [
                { text: '首页', link: '/' },
                { text: '指南', link: '/guide/' },
                {
                    text: '接口', items: [
                        { text: '微信小程序', link: '/interface/wxapi/' },
                        { text: '网站', link: '/interface/web/' }
                    ]
                },
                { text: '我的博客', link: 'https://www.cnblogs.com/flypig666' },
                { text: '我的码云', link: 'https://gitee.com/flypig666/projects' },
            ],
            sidebar: {
                "/guide/": [""],
                "/interface/wxapi/": [""],
                "/interface/web/": [""],
            }
        }
    })

    3、我的文件目录如下:

  • 相关阅读:
    MySQL数据库之数据类型
    MySQL数据库之数据操作
    MySQL数据库之表的操作
    十、原子操作
    九、std::async异步线程
    八、条件变量
    cisco笔试记录
    七、单例设计模式
    基于HTTP的功能追加协议
    使用栈来计算后缀表达式
  • 原文地址:https://www.cnblogs.com/flypig666/p/12060997.html
Copyright © 2011-2022 走看看