用 Gulp 搭建的演示文档

所属：Tools

最近在整理项目相关的东西时，要写些注释说明和帮助其他人快速的了解整理个项目的大概情况，不想每次都跟其他人解释一遍，于是就有了这个东西拉。

Mini Wiki 是什么？

Mini Wiki —- 用 Gulp + Markdown 等开源组件搭建起来的，用于简单文档演示站点。

Mini Wiki 目的

解决某些项目里样式文件多、乱…，而且也没多少人明白，此处省略一万个字，说多就是泪呐！

写文档、写文档、写文档…

安装与用法

1
2
3
4
https://github.com/iamocean/mini-wiki.git
cd mini-wiki/
npm install
gulp
  1. 先从 Github 上把代码 clone 下来
  2. 然后进入对应的目录（如：mini-wiki），安装依赖包(npm install)
  3. 执行 gulp 预览
  4. 修改 markdown 文件夹的 *.md 可实时更新预览

目录结构说明

1
2
3
4
5
6
7
8
9
10
11
mini-wiki
├── assets/
│     ├── css/
│     ├── img/
│     ├── js/
├── layout/
├── markdown/
├── .gitnore
├── gulpfile.js
├── index.html
└── package.json
  • assets 是用来放静态资源的
  • markdown 是用来放 .md 的源文件

嗯，其他的不解释了..

重点注意下 layout 是用来 HTML 拆出来的结构，这里需要注意下 gulp-html-extend 插件语法。（我是传送门）