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-16
目录

文档 - 快速上手

  • 准备
  • 快速开始
  • 配置信息修改
  • 详情请看

使用 vuepress (opens new window) 及主题 vdoing (opens new window) ,自动部署在GitHub Pages (opens new window)

纯新手可看 bilibili 的 vuepress 视频教程:https://www.bilibili.com/video/BV17t41177cr (opens new window)

# 准备

VuePress 需要 Node.js (opens new window)>= 8.6

首先需要下载 Node.js

  1. 克隆到本地并进入目录

    git clone https://github.com/oddfar/notes.git && cd notes
    
    1

    或 gitee 地址:

    git clone https://gitee.com/oddfar/notes.git && cd notes
    
    1
  2. 安装本地依赖

    npm install
    
    1
  3. 本地测试

    npm run dev
    
    1

    默认访问链接:http://localhost:8080 (opens new window)

# 快速开始

使用 markdown 语法编写 md 文件,所有笔记 md 文件放在 docs/ 目录下

例如添加 test 类,并编写 hello.md 文件

  1. 创建目录

    格式:序号+标题

    例如:30.test

  2. 添加笔记

    例如:01.hello.md

  3. 编写内容

    ## 标题
    
    hello world
    
    1
    2
    3
  4. 测试运行

    在项目根目录下

    npm run dev
    
    1

    会自动生成

    tittle:标题,默认文件名,即 hello

    permalink:访问链接

    date:日期,默认文件创建时间

# 配置信息修改

一些常用的

目录 docs\.vuepress 下

  • config.js

    修改 vuepress 和主题一些配置

  • config\nav.js

    修改首页导航栏

# 详情请看

关于 vuepress 的配置:

  • vuepress官方文档 (opens new window)
  • vdoing主题介绍文档 (opens new window)
在 GitHub 上编辑此页 (opens new window)
最后更新: 2021/08/03, 15:08:00
关于 - 我
文档 - md文件写作

← 关于 - 我 文档 - md文件写作→

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