最近准备对前端知识做一个梳理,将自己的平时遇到的问题和解决方案形成一个知识文档。本文记录了搭建 VuePress 的主要过程,同时也提供了部分自定义的配置,示例地址:http://doc.i-fanr.com

环境搭建

VuePress 有着比较完善的中文文档,我们可以直接参照文档搭建,首先确保电脑上已经安装了 Node.js 并且版本号不小于 8.6

# 检查 Node.js 版本号
node -v

建立一个文件夹用来搭建 VuePress, 例如我的 VuePress 搭建在 spacexcode目录 下

mkdir spacexcode && cd spacexcode

将 VuePress 安装为本地依赖

yarn add -D vuepress # npm install -D vuepress

创建你的第一篇文档

mkdir docs && echo '# Hello VuePress' > docs/README.md

在 package.json 中添加一些 scripts

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

在本地启动服务器

yarn docs:dev # npm run docs:dev

添加主题

环境添加完毕后接下来就是装修完善了,VuePress 的原始样式更适合制作文档,因此我们需要自定义样式。VuePress 提供了自定义主题与样式的方法,为了简单我们可以直接使用别人制作好的博客主题 这里推荐一个我正在使用的主题 vuepress-theme-reco 主题的使用方法文档中已经介绍的很详细了,这里分享几个我自己的自定义设置

修改页面样式

原始主题的页面内容宽度最大值是固定的,在我的大屏幕上显得有些窄了,因此我将文本宽度改为了页面宽度的 50%,这个设置与 Hexo 的设置一致,每个人可以根据自己的爱好修改。在 .vuepress/styles/palette.styl 文件中添加如下样式

// 首页内容宽度更改为页面的 75%
.home-blog.home-blog-wrapperwidth :75%// 文章页内容宽度更改为页面的 50%
.page.page-titlemax-width :50%.content__default:not(.custom)max-width :50%.page-navmax-width :50%.comments-wrappermax-width :50% !important

添加插件

安装插件,以  vuepress-plugin-image插件为例

yarn add vuepress-plugin-image

然后在 config.js 中添加插件

plugins: ['@vuepress/plugin-back-to-top','@vuepress/plugin-medium-zoom','image']

添加主题中未包含的插件,这里介绍几个我使用的插件 vuepress-plugin-viewer 一个图片查看插件 vuepress-plugin-pangu 自动在文章中英文与汉字之间添加空格 vuepress-plugin-tabs 增加一个带有 tab 标签的容器 vuepress-plugin-click 鼠标点击时增加特殊效果 vuepress-plugin-demo-block 添加 H5 代码预览区块

部署

博客搭建完成后需要部署,我们可以创建一个 shell 文件来打包部署,我的部署到 github.io 下面,这是我的 shell 文件

#!/usr/bin/env sh# 确保脚本抛出遇到的错误
set -e# 生成静态文件
yarn docs:build# 进入生成的文件夹
cd docs/.vuepress/distgit init
git add -A
git commit -m 'deploy'
git push -f git@github.com:fantingsheng/spacexcode.git master

- END -

太空编程

分享硬核的编程知识

分享精彩,码上快乐。JavaScript已然上天,有朝一日实现太空编程!回复【pdf】更有海量的优质电子书供下载。

spacexcode

使用 VuePress 搭建一个自己的知识文档相关推荐

  1. 从0开始如何搭建一个网络游戏-超级详细文档

    2019独角兽企业重金招聘Python工程师标准>>> 下面介绍从0开始如何搭建一个网络游戏的全过程,希望帮到有需要的人. 搭建的过程会有遇到很多问题,我也在搭建的过程中把遇到的问题 ...

  2. 利用天翎知识文档+群晖NAS搭建企业知识库,享用智能检索

    编者按:检索是知识文档管理中常见切十分重要的功能,搭建企业知识库必不可少.本文分析了智能检索的特点,并介绍了其在知识文档管理系统中的实现. 关键词:智能检索,移动端,群晖NAS 知识管理中的检索功能 ...

  3. 企业的知识文档管理系统需要注重什么?安全和共享能力很重要!

    编者按:本文指出了企业的文档管理系统比较注重的能力,并从知识共享和文档安全两方面介绍了老厂商天翎是如何在这块实践的. 关键词:知识共享,知识安全,标签分类,智能检索,资料分享,在线编辑,权限管理,文档 ...

  4. DEVONthink + Notion 搭建一个完美的知识管理体系

    时至今日,互联网的分享难度大大降低,有道云笔记.Evernote.OneNote.为知笔记等笔记应用次第兴起,也带来了丰富的方式来保存你所感兴趣的内容,当然也不得不提后起之秀 Notion 和主打本地 ...

  5. 手把手教你搭建一个中式菜谱知识图谱可视化系统

    手把手教你搭建一个中式菜谱知识图谱可视化系统 中式菜谱知识图谱 1.系统功能 2.先来看看效果 实体间关联关系及实体信息显示 不同类型实体开关显示 搜索功能展示 3.系统实现流程 3.1 数据爬取 3 ...

  6. 如何搭建一个自己的知识付费平台

    如何搭建一个自己的知识付费平台 近年来,知识付费网课商城项目是一种特别流行的互联网赚钱方式.从运营模式来看,适合公司.工作室.个人.越来越多的人依靠知识付费的在线课程项目,月入超过1万元. 构建知识付 ...

  7. 2023年如何搭建最小可行性的产品文档/产品手册?

    在推出并击败竞争对手进入市场的竞赛中,很容易将"不必要的"任务(如文档)放在次要位置.但根据 Write the Docs 纪录片社区的说法,文档应该既是先导性的,也是参与性的.这 ...

  8. 天翎知识文档系统+群晖NAS,助力企业实现移动化学习

    编者按:移动化学习成为一种社会发展趋势,本文分析了企业移动化学习的意义,并提出了企业移动化学习的一款全新解决方案--天翎知识文档系统+群晖NAS. 关键词:多端适配,学习培训,智能问答,在线预览,在线 ...

  9. 如何低成本减少企业知识流失?天翎知识文档系统+群晖NAS值得一试

    编者按:知识管理可以减少企业知识流失,有效提高企业员工工作水平,增强企业综合竞争力.如何小成本做好企业知识管理呢?天翎知识文档系统+群晖NAS值得一试. 关键词:标签分类,权限管理,在线预览,在线编辑 ...

最新文章

  1. MYSQL 类ORACLE序列实现遇到的问题
  2. 最爱莫乎生命,其次是“你”
  3. MaskedTextBox的聚焦和光标位置
  4. 【通知】深度学习之人脸图像算法核心代码开源和勘误汇总
  5. 【JOURNAL】康生篆书联
  6. 数据导入时遭遇 ORA-01187 ORA-01110
  7. Ubuntu apt-get方式安装Subversion
  8. 第二十四章 异常和错误处理 1异常
  9. 桌面虚拟化究竟能给我们带来什么?
  10. 中国开放教育资源协会
  11. python android开发_Android与Python爱之初体验
  12. Vue源码解读之事件机制
  13. Java---类反射(1)---类反射入门和基础
  14. Java分布式服务框架Dubbo初探(待实践)
  15. 基于百度云AI开发车型识别车牌识别案例详解
  16. 关于地理数据坐标转换
  17. matlab解方java_学习笔记190—利用matlab求解方程组的解
  18. 2021旗帜软件工作室年会总结
  19. Ribbon--概述
  20. Cadence16.5 叠层设置怎样设置正片负片

热门文章

  1. 视频光端机常见问题解决方法
  2. 工业交换机出现故障问题排查步骤详解
  3. 【渝粤教育】国家开放大学2018年春季 8634-21TAndroid智能手机编程 参考试题
  4. java list比较器_JAVA比较器
  5. 数据库迁移mysql到sqlserver_数据库迁移(sqlserver至mysql)
  6. java 三元 代替 if_Java 中三元和 if else 哪个的效率比较高,有底层解释吗,谢谢了!...
  7. 综合知识计算机类编制,天津事业编综合知识是什么
  8. 微信小程序开发学习记录01
  9. Firewall配置
  10. 一致性哈希算法原理分析及实现