# BirdDoc

**Repository Path**: xsolution/BirdDoc

## Basic Information

- **Project Name**: BirdDoc
- **Description**: 快速搭建自己的文档系统, 全部用Markdown来编写文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-12-16
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 前言

<p align="center">
  <a href="https://vuepress.vuejs.org/" target="_blank">
    <img width="180" src="https://images.cnblogs.com/cnblogs_com/jackson0714/809472/o_qrcode_wkljg.jpg" alt="logo">
  </a>
</p>

<p align="center">
  <a href="https://www.cnblogs.com/jackson0714/p/birddoc.html"><img src="https://img.shields.io/npm/v/drone.svg" ></a>
  <a href="https://www.cnblogs.com/jackson0714/p/birddoc.html"><img src="https://img.shields.io/badge/language-markdown-Red.svg" ></a>
</p>

![avatar](https://raw.githubusercontent.com/Jackson0714/BirdDoc/master/BirdDoc.png)

# 此项目是专门用来展示文档的

## 工具地址
http://birddoc.jayh.club  

## 博客地址
https://www.cnblogs.com/jackson0714/p/birddoc.html

## 支持的功能:
### 1.顶部具有搜索功能
### 2.左侧具有导航功能
### 3.全部用markdown语法写文档
### 4.支持本地部署

## 用到的技术
### vue.js

## 准备工作
### 安装 Node.js
### Windows 下载 https://nodejs.org/dist/v8.1.2/node-v8.1.2-x64.msi 安装
### Linux & macOS 如下：
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash
nvm install 8.1.2
nvm alias default 8.1.2

## 安装 npm 依赖
npm install

## 启动预览服务
启动成功后会提示“VuePress dev server listening at http://xxx”，在浏览器中打开提示的地址即可   
npm start