diff --git a/README.md b/README.md index 69161d6..8a2b9e0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ # TheBlog A system to build your own blog site. +修改一个配置文件,即可搭建出你自己的博客平台。 + + + +### 使用环境 + +- node >= v8 +- mysql +- npm + ### 如何使用? @@ -17,5 +27,36 @@ git clone git@github.com:Reaper622/TheBlog.git npm install ``` -- +- 执行初始化命令 + +``` +npm run init +``` + +- 根据`config.sample.js`完成对 MySQL数据库的配置,完成后修改文件名为`config.js` +- 修改`config.json`内部分自定义设置 +- 在 `articles`文件夹下创建文档目录 + +``` +articles/ +|-- label 标签 + |-- year 年份 + |-- month 月份 + |-- day 日期 + |-- filename 文件 +``` + +- 执行打包命令 + +``` +npm run build +``` + +- 执行服务端运行指令 + +``` +npm run server +``` + +- 访问 [localhost:4000](locahost:4000) 即可访问