diff --git a/md2site/template/app/src/docs/cn/installation.md b/md2site/template/app/src/docs/cn/installation.md index 5fa3a89b4..13bdc0fd3 100644 --- a/md2site/template/app/src/docs/cn/installation.md +++ b/md2site/template/app/src/docs/cn/installation.md @@ -1,25 +1,28 @@ -

安装

+## 简介 -[Omi](https://github.com/AlloyTeam/omi)(读音 / [ˈomɪ] /, 汉字类似于 欧米) 是一款用于创建用户界面的组件化框架,开放并且现代,故得名:Omi。 +Md2site是基于[Omi](https://github.com/AlloyTeam/omi)的一款Markdown转网站工具,使用简单,生成的文件轻巧,功能强大。 -### 安装 Omi - -我们推荐使用 [npm](https://www.npmjs.com/) 来管理你的前端依赖. - -通过npm安装Omi,你只需要执行下面的命令: +## 安装使用 md2site ``` js -$ npm install omi +$ npm install md2site -g +$ md2site init your_project_name +$ cd your_project_name +$ npm run dev +$ npm run dist ``` -## omi-cli +## Md2site 与 Hexo 对比 -你也可以通过omi-cli去初始化你的项目: +| | Md2site | Hexo | +| ------------- |:-------------:|:-----:| +| Markdown支持 | ★★★★★| ★★★★★ | +| 网站文件尺寸 | ★★★☆☆ | ★★★★★ | +| 上手难度 | ★★★★★| ★★★★★ | +| 二次开发 | ★★★★☆ | ★★★★★ | +| 主题与插件 | ★★★★★ | ★★★★☆ | +| 代码指定行高亮 | ★★★★☆ | ★★★★★ | +| 多语言支持 | ★★★★☆ | ★★★★★ | +| 响应式 | ★★★★★ | ★★★★★ | -``` js {1} -$ npm install omi-cli -g //安装cli -$ omi init your_project_name //初始化项目,你也可以在一个空的文件夹下执行 omi init -$ cd your_project_name //如果你是在空文件夹下执行的 omi init。请无视这条命令 -$ npm run dev //开发 -$ npm run dist //部署发布 -``` \ No newline at end of file + 注:星星更多的,代表对比获胜。 diff --git a/md2site/template/app/src/docs/en/installation.md b/md2site/template/app/src/docs/en/installation.md index 22fe5e917..b706b9e2d 100644 --- a/md2site/template/app/src/docs/en/installation.md +++ b/md2site/template/app/src/docs/en/installation.md @@ -1,22 +1,28 @@ -

Installation

+## Introduction -[Omi](https://github.com/AlloyTeam/omi) is open and modern framework for building user interfaces. +Md2site is a fast, simple & powerful framework that can be used for transformation of markdown to website based on [Omi](https://github.com/AlloyTeam/omi). -### Installing Omi - -We recommend using [npm](https://www.npmjs.com/) for managing front-end dependencies. If you're new to package managers. - -To install Omi with npm, run: +## Usage ``` js -$ npm install omi +$ npm install md2site -g +$ md2site init your_project_name +$ cd your_project_name +$ npm run dev +$ npm run dist ``` -### omi-cli -``` js {1} -$ npm install omi-cli -g -$ omi init your_project_name -$ cd your_project_name -$ npm run dev -$ npm run dist -``` \ No newline at end of file +### Md2site VS Hexo + +| | Md2site | Hexo | +| ------------- |:-------------:|:-----:| +| Markdown support | ★★★★★| ★★★★★ | +| File size of generated website | ★★★☆☆ | ★★★★★ | +| Difficulty of getting started | ★★★★★| ★★★★★ | +| Secondary development | ★★★★☆ | ★★★★★ | +| Themes and plugins | ★★★★★ | ★★★★☆ | +| Code specifies row highlight | ★★★★☆ | ★★★★★ | +| Multi language support | ★★★★☆ | ★★★★★ | +| Responsive | ★★★★★ | ★★★★★ | + + Note: more stars mean win. \ No newline at end of file