vue文档

Typora——Vue文档风格主题设置
千次阅读

2020-05-17 17:18:11

Typora——Vue文档风格主题设置

目标：写代码时少不了写markdown文档，使用Typora来编写时总觉得主题不美观，如何更换？（有道云笔记、印象笔记等等都可以，个人推荐Typora，适用于公司办公）

1. Typora的介绍与下载

Typora是一款支持实时预览的 Markdown 编辑器和阅读器，支持Windows、macOS、Linux三大平台。Typora 作为一款合格的 Markdown 编辑器，支持图片、列表、表格、代码、公式、目录等功能，同时这款软件还支持（一键）动态预览功能，让一切都变得如此干净、纯粹，并且有多种主题模板。下载链接：Typora官网。

2. Typora-vue-theme的介绍与下载

typora-vue-theme是参考了Vue文档风格而开发的一个 Typora 自定义主题。下载链接：百度输入：GitHub,typora,vue。

3. 如何安装主题

a. 下载本主题中的vue.css、vue-dark.css文档和包含字体的vue文档夹；

b. 打开 Typora，点击“偏好设置” => “打开主题文档夹”按钮，将弹出 Typora 的主题文档夹；

c. 将下载好的vue.css和vue-dark.css文档和包含字体的vue文档夹放到 Typora 的主题文档夹中；

d. 关闭并重新打开 Typora，从菜单栏中选择 “主题” => “Vue” 或者 “Vue Dark” 即可。

4. 效果图

参考链接：

1. Vue 文档风格的 Typora 主题

markdown

更多相关内容
ant-design-vue离线文档
2019-09-23 22:32:33

vue ant design的离线文档，解压后打开目录 npm install 运行 npm start 启动默认项目地址为 localhost:3000

收起
vue离线中文dash文档.rar
2019-09-22 22:12:56

cn.vuejs.org同步dash文档，Vue版本为2.6.10，更新时间2019/9/22

收起
将vue文档下载到本地预览
万次阅读 2018-10-24 15:57:16
将vue文档下载到本地预览由于vue文档在服务器在国外，因此访问速度较慢，为了方便文档查看，可以将文档下载到本地预览步骤到vue的GitHub仓库下载文档源码下载node.js和git安装到本地初始化文档并部署 1...
将vue文档下载到本地预览

由于vue文档在服务器在国外，因此访问速度较慢，为了方便文档查看，可以将文档下载到本地预览
- 步骤
1. 到vue的GitHub仓库下载文档源码
2. 下载node.js和git安装到本地
3. 初始化文档并部署
1、到vue的GitHub仓库下载文档源码

vue文档的源码放在GitHub仓库，地址
```
https://github.com/vuejs/cn.vuejs.org
```
将文档下载下来到本地并解压

2、下载node.js和git安装到本地

node.js安装

到node.js官网下载最新的安装包

node.js官网

https://nodejs.org/en/

下载带有LTS的版本

然后傻瓜式安装，安装后需要做一些配置，具体参考

https://www.cnblogs.com/goldlong/p/8027997.html

Git安装

git官网

https://gitforwindows.org/

同样是傻瓜式安装

3、初始化文档并部署

初始化

最后一步win+R–>cmd打开命令行窗口，cd 进入刚刚从GitHub上下载下来的vue文档源码

然后输入初始化命令并回车
```
npm install
```
初始化成功

部署

依然是在命令行下输入一下部署命令并回车
```
npm start
```
部署成功，默认地址是：http://localhost:4000

到此就可以直接在本地阅读文档了，没有网也可以

浏览器输入：http://localhost:4000

如果要修改端口的话可以打开根目录中的_config.yml文件

右键–>文本格式打开

在此更改就可以了

这种部署方式用到的是hexo，一种博客框架，感兴趣的可以去了解，附上官网链接

https://hexo.io/zh-cn/

-完
收起
展开全文
vue
vue实现pdf文档在线预览功能
2020-10-15 22:57:01

主要为大家详细介绍了vue实现pdf文档在线预览功能，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下

收起
Vue.js学习文档
2017-06-12 20:48:46

Vue.js 架构学习

收起
fullcalendar-vue:FullCalendar的官方Vue组件
2021-04-29 20:58:38

FullCalendar Vue组件该项目为FullCalendar提供了正式的Vue组件，并且具有相同的设置。

收起

JavaScript
VuePress 手摸手教你搭建一个类Vue文档风格的技术文档/博客
千次阅读 2018-09-10 10:23:03
VuePress是尤大为了支持 Vue 及其子项目的文档需求而写的一个项目，VuePress界面十分简洁，并且非常容易上手，一个小时就可以将项目架构搭好。现在已经有很多这种类型的文档，如果你有写技术文档的项目的话，Vue...
前言：

VuePress是尤大为了支持 Vue 及其子项目的文档需求而写的一个项目，VuePress界面十分简洁，并且非常容易上手，一个小时就可以将项目架构搭好。现在已经有很多这种类型的文档，如果你有写技术文档的项目的话，VuePress绝对可以成为你的备选项之一。

VuePress特性：
- 为技术文档而优化的内置 Markdown 拓展
- 在 Markdown 文件中使用 Vue 组件的能力
- Vue 驱动的自定义主题系统
- 自动生成 Service Worker
- Google Analytics 集成
- 基于 Git 的 “最后更新时间”
- 多语言支持
- 默认主题包含：
建议先看一下官方文档

效果：

可能你会搭建出一个类似这样的文档：

搭建：

全局安装VuePress
```
yarn global add vuepress # 或者：npm install -g vuepress
```
新建文件夹

可以手动右键新建，也可以使用下面的命令新建文件夹：
```
mkdir project
```
项目初始化

进入到project文件夹中，使用命令行初始化项目:
```
yarn init -y # 或者 npm init -y
```
将会创建一个package.json文件，长这样子：
```
{
  "name": "project",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}
```
在project的根目录下新建docs文件夹：

这个文档将作为项目文档的根目录来使用：
```
mkdir docs
```
在docs文件夹下创建.vuepress文件夹：
```
mkdir .vuepress
```
所有 VuePress 相关的文件都将会被放在这里

在.vuepress文件夹下面创建config.js:
```
touch config.js
```
config.js是VuePress必要的配置文件，它导出一个javascript对象。

你可以先加入如下配置：
```
module.exports = {
  title: 'Hello VuePress',
  description: 'Just playing around'
}
```
在.vuepress文件夹下面创建public文件夹:
```
mkdir public
```
这个文件夹是用来放置静态资源的，打包出来之后会放在.vuepress/dist/的根目录。

首页(像VuePress文档主页一样)

在docs文件夹下面创建一个README.md：

默认的主题提供了一个首页，像下面一样设置home:true即可，可以把下面的设置放入README.md中，待会儿你将会看到跟VuePress一样的主页。
```
---
home: true
heroImage: /logo.jpg
actionText: 快速上手 →
actionLink: /zh/guide/
features:
- title: 简洁至上
  details: 以 Markdown 为中心的项目结构，以最少的配置帮助你专注于写作。
- title: Vue驱动
  details: 享受 Vue + webpack 的开发体验，在 Markdown 中使用 Vue 组件，同时可以使用 Vue 来开发自定义主题。
- title: 高性能
  details: VuePress 为每个页面预渲染生成静态的 HTML，同时在页面被加载的时候，将作为 SPA 运行。
footer: MIT Licensed | Copyright © 2018-present Evan You
---
```
ps：你需要放一张图片到public文件夹中。

我们的项目结构已经搭好了：
```
project
├─── docs
│   ├── README.md
│   └── .vuepress
│       ├── public
│       └── config.js
└── package.json
```
在 package.json 里添加两个启动命令:
```
{
  "scripts": {
    "docs:dev": "vuepress dev docs",
    "docs:build": "vuepress build docs"
  }
}
```
启动你的VuePress：

默认是localhost:8080端口。
```
yarn docs:dev # 或者：npm run docs:dev
```
构建：

build生成静态的HTML文件,默认会在 .vuepress/dist 文件夹下
```
yarn docs:build # 或者：npm run docs:build
```
基本配置：

最标准的当然是官方文档,可以自己的需求来配置config.js。

可以参考一下我的config.js的配置：
```
module.exports = {
  title: '网站标题',
  description: '网站描述',
  // 注入到当前页面的 HTML <head> 中的标签
  head: [
    ['link', { rel: 'icon', href: '/favicon.ico' }], // 增加一个自定义的 favicon(网页标签的图标)
  ],
  base: '/web_accumulate/', // 这是部署到github相关的配置 下面会讲
  markdown: {
    lineNumbers: true // 代码块显示行号
  },
  themeConfig: {
    sidebarDepth: 2, // e'b将同时提取markdown中h2 和 h3 标题，显示在侧边栏上。
    lastUpdated: 'Last Updated' // 文档更新时间：每个文件git最后提交的时间
  }
};
```
导航栏配置：
```
module.exports = {
  themeConfig: {
    nav:[
      { text: '前端算法', link: '/algorithm/' }, // 内部链接 以docs为根目录
      { text: '博客', link: 'http://obkoro1.com/' }, // 外部链接
      // 下拉列表
      {
        text: 'GitHub',
        items: [
          { text: 'GitHub地址', link: 'https://github.com/OBKoro1' },
          {
            text: '算法仓库',
            link: 'https://github.com/OBKoro1/Brush_algorithm'
          }
        ]
      }        
    ]
  }
}
```
侧边栏配置：

侧边栏的配置相对麻烦点，我里面都做了详细的注释，仔细看，自己鼓捣鼓捣就知道怎么搞了。
```
module.exports = {
  themeConfig: {
      sidebar:{
        // docs文件夹下面的accumulate文件夹 文档中md文件 书写的位置(命名随意)
        '/accumulate/': [
            '/accumulate/', // accumulate文件夹的README.md 不是下拉框形式
            {
              title: '侧边栏下拉框的标题1',
              children: [
                '/accumulate/JS/test', // 以docs为根目录来查找文件 
                // 上面地址查找的是：docs>accumulate>JS>test.md 文件
                // 自动加.md 每个子选项的标题 是该md文件中的第一个h1/h2/h3标题
              ]
            }
          ],
          // docs文件夹下面的algorithm文件夹 这是第二组侧边栏 跟第一组侧边栏没关系
          '/algorithm/': [
            '/algorithm/', 
            {
              title: '第二组侧边栏下拉框的标题1',
              children: [
                '/algorithm/simple/test' 
              ]
            }
          ]
      }
  }
}
```
其他：

代码块编译错误：

像下面这段代码会导致编译错误，VuePress会去找里面的变量，把它编译成text：
```
{{}} 啦 {{}}
```
所以我们的代码块要以这种形式书写：
```
//```js
{{}} 啦 {{}} // 注释需要打开 这样vuepress会把这里面包裹的当成代码块而不是js
//```
```
并且这样也会让我们的代码高亮显示(下图第一个没有高亮，第二个有高亮)，阅读体验更好：

自定义容器了解一下：

更改标题：
```
::: tip 替换tip的标题
这里是内容。
:::
```
其实文档里有，我这里只是提一下。

支持Emoji

文档中只提了支持Emoji,我在GitHub上找到了Emoji的列表，分享一下。

一个命令行发布到github上：

在 docs/.vuepress/config.js 中设置正确的 base:

如果你打算发布到 https://<USERNAME>.github.io/，则可以省略这一步，因为 base 默认即是 "/"。

如果你打算发布到 https://<USERNAME>.github.io/<REPO>/（也就是说你的仓库在 https://github.com/<USERNAME>/<REPO>），则将 base 设置为 "/<REPO>/"。
```
module.exports = {
  base: '/test/', // 比如你的仓库是test
}
```
创建脚步文件:

在project的根目录下，创建一个deploy.sh文件：
```
#!/usr/bin/env sh

# 确保脚本抛出遇到的错误
set -e

# 生成静态文件
npm run docs:build

# 进入生成的文件夹
cd docs/.vuepress/dist

# 如果是发布到自定义域名
# echo 'www.example.com' > CNAME

git init
git add -A
git commit -m 'deploy'

# 如果发布到 https://<USERNAME>.github.io  USERNAME=你的用户名 
# git push -f git@github.com:<USERNAME>/<USERNAME>.github.io.git master

# 如果发布到 https://<USERNAME>.github.io/<REPO>  REPO=github上的项目
# git push -f git@github.com:<USERNAME>/<REPO>.git master:gh-pages

cd -
```
设置package.json：

{
“scripts”: {
“d”: “bash deploy.sh”
}
}

部署：

然后你每次可以运行下面的命令行，来把最新更改推到github上：
```
    npm run d
```
如果你对运行项目和构建项目的命令行觉得很烦，你也可以像我这么做：
```
"scripts": {
    "dev": "vuepress dev docs", // 本地运行项目 npm run dev
    "build": "vuepress build docs", // 构建项目 nom run build
    "d": "bash deploy.sh" // 部署项目 npm run d
  },
```
更多：

实际上VuePress的配置、用法还有很多，像还可以配置PWA，以及在markdown里面使用Vue组件等，这些功能我也还在摸索，所以大家一定要去看文档!

结语

上面已经写得尽可能详细了，我遇到的坑都写上去了。搭建起来确实很简单，心动不如行动，随手花一两个小时搭建一下又不吃亏，何乐而不为？

希望看完的朋友可以点个喜欢/关注，您的支持是对我最大的鼓励。

个人blog and 前端积累文档，如需转载，请放上原文链接并署名。码字不易，感谢支持！

如果喜欢本文的话，欢迎扫描关注我的订阅号，最新文章，面试题等都将第一时间发布在订阅号上。

以上2018.9.9
收起
展开全文
ant design vue.docx
2021-05-04 18:07:03

ant design vue

收起

前端
Ant Design of Vue v1.7.2 使用教程.pdf
2021-05-23 23:40:10

Ant Design vue v1.7.2 离线文档

收起
vue项目规范文档
2019-01-17 15:20:51

vue项目开发常见规范，可以帮助代码易于阅读，团队合作，提高开发效率，提高个人代码编码规范。

收起
vue实现word，pdf文件的导出功能
2020-12-09 17:00:59

vue实现word或pdf文档导出的功能，我的项目是：后端返回一个文档流(下图)，然后前端对文档流做处理进行下载，代码如下： import axios from 'axios'; axios.get(`url`, { //url: 接口地址 responseType: `...

收起
Vue最新文档PDF
2017-02-16 17:25:06

Vue最新文档PDF-20170216

收起
vue-contextmenu
2021-05-09 08:17:14

开发文档使用方式引入依赖 npm i @shymean/vue-contextmenu -S // 引入默认菜单样式，如果使用自定义菜单组件则无需引入 import '@shymean/vue-contextmenu/dist/index.css' import contextmenu from '@shymean/...

收起

JavaScript
vue技术文档
2017-03-13 21:02:33

vue文档

收起
vue学习文档.pdf
2019-12-10 17:17:50

vue的学习文档，比较全面。学习

收起
VUE 中文文档
千次阅读 2020-09-15 20:41:54
VUE 中文文档本地化近期家里网络不太好，看 VUE 文档有时都没有办法看。所以研究了一下将 VUE文档加载到本地，享受没网的时候也能畅游学习。同时将这个方法分享给大家。
Vue文档本地化

1. 下载源码
2. node.js 的下载与配置
3. 部署项目
4. 一键启动服务
近期家里网络不太好，看 VUE 文档有时都没有办法看。所以研究了一下将 VUE文档加载到本地，享受没网的时候也能畅游学习。同时将这个方法分享给大家。

1. 下载源码
- 首先要先进入 GitHub 网站将 VUE 的中文 Doc文档下载下来。
- 地址：https://github.com/vuejs/docs-next-zh-cn
- 然后解压文件夹，并放到合适的目录下 PS （我这里放到了 E:\Project\docs-next-zh-cn-master 目录下）
- 因为 VUE 的中文文档是基于 Vuepress 构建而成的，内容是在 src 文件内，格式为 Markdown。
- 所以我们要下载 node.js 进行支持，并下载一些依赖文件。
2. node.js 的下载与配置
- node.js 官网：https://nodejs.org/en/
- 我是复制下载链接，通过迅雷下载的。唉，官网不友好啊，下载速度慢。
- 下载完成以后，双击进行安装，一路 next 搞定。
- # 安装完成以后按 windows键 + R 输入 cmd 进入 dos 窗口输入 node -v #进行查看版本，显示版本则成功安装。
- 因为node.js 是国外的，跟maven一样要配置国内的镜像
- # dos 窗口输入 // 设置淘宝镜像源 npm config set registry https://registry.npm.taobao.org // 查看使用的镜像源 npm config get registry // 安装淘宝镜像源 npm install -g cnpm --registry=https://registry.npm.taobao.org // 安装 npm install -g vuepress
3. 部署项目
- 使用 dos 窗口进入 VUE 文档的解压目录
- # 例如我的 E: #进入E 盘 cd Project/docs-next-zh-cn-master # 进入目录中 npm install # 加载依赖 npm run serve # 当依赖加载完毕之后，启动项目（之后启动也是这么启动）
dos 窗口关闭会导致本地页面不能访问哦，因为它是前台服务，一旦你关闭，它就会认为你不使用了，然后将服务kill 掉咯

4. 一键启动服务

如果使用 dos命令的话，还要进入窗口进行操作，作为一个懒人，咱们肯定嫌弃麻烦咯
```
首先创建一个文本
然后将 代码粘贴到 文本中保存

cmd /k "cd /d E:\Project\docs-next-zh-cn-master&&npm run serve"

保存 文件，并将文件后缀 改为 .bat 格式
然后 每一次 启动，直接双击运行。
```
收起
展开全文
Vue API 文档-英文原版
2017-12-06 09:44:01

英文版 Vue API 文档，非最新版，Vue v1.0 的 API. 包含 Vue 类与实例的 API.

收起
vue组件文档（.md）中如何自动导入示例（.vue）详解
2020-10-17 11:40:49

主要给大家介绍了关于vue组件文档（.md）中如何自动导入示例（.vue）的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

收起
vue前端架构文档
2019-03-13 14:17:51

VUE前端架构说明文档

收起
零基础学习vue文档详解
千次阅读 2018-09-26 18:27:44

vue init webpack vue-project //vue-project项目名称启动项目 npm run dev 2.3. vue-cli项目解释 src目录 - assets: 存放静态资源，比如图片 - components: 存放组件 - router/index.js 配...

收起
VUE2.0离线帮助文档 Chm
2018-06-27 22:20:23

本文档为离线帮助文档，方便程序员在没有网的情况下快速找到想要的。下载后解压就好

收起
实现Vue的markdown文档可以在线运行的方法示例
2020-10-17 15:38:52

主要介绍了实现Vue的markdown文档可以在线运行的方法示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

收起
最新尚硅谷全套，包含VUE.JS
热门讨论 2018-05-28 17:21:03

最新尚硅谷全套，包含VUE.JS教程等一系列信息，最新尚硅谷全套，包含VUE.JS教程等一系列信息

收起
vuejs官方离线中文文档
2019-05-05 09:12:12

这是cn.vuejs.org 官网文档的同步版本，本文档最后更新时间：2018-10-30 对应vuejs最新稳定版本：2.5.16 (Vuejs每个版本的更新日志见 GitHub)

收起
焕然一新的 Vue 3 中文文档来了
千次阅读 2022-03-23 10:23:08

大家好，我是LBJ，最近参与了 Vue 3新文档的翻译和校验工作我们知道 Vue 3 新文档 ( vuejs.org ) 已经发布一个多月了，但那是英文版的，不知道你看了没？没有看，那就有福了！中文版翻译要来了为什么说它要来了呢...

收起
ant-designer-vue离线文档1.+版本
2022-01-21 15:36:39

ant-designer-vue离线文档1.+版本

收起
vue项目最新最全开发规范文档
2019-02-21 10:30:32

通过整合、结合自身项目需要，为了便于后期项目团队成员的配合，是一份最新，最全的vue开发文档规范。

收起
前端Vue开发技术文档案例
2019-04-12 10:25:00

Vue中文社区独家公众号,面向前端爱好者, 每日更新最有料的文章,最前沿的资讯,内容包含但不限于Vue,React,Angular,前端工程化...等各种"大保健"知识点,右上角...

收起
Vue-grid-layout官方文档
2022-03-11 16:35:36

1.详细介绍了Vue-Gird-layout的使用及API

收起