docs: $ before bash command

This commit is contained in:
DIYgod
2018-05-16 14:39:48 +08:00
parent 2a03199251
commit dfdc015f4f
+27 -19
View File
@@ -24,7 +24,7 @@ sidebar: auto
windows 打开 `cmd`, macOS 打开`终端(terminal)`。
``` bash
git
$ git
usage: git [--version] [--help] [-C <path>] [-c name=value]
...
```
@@ -44,13 +44,13 @@ Windows 用户请 [下载安装程序](https://nodejs.org/zh-cn/)。安装时,
安装 `nvm`
``` bash
curl https://raw.github.com/creationix/nvm/master/install.sh | sh
$ curl https://raw.github.com/creationix/nvm/master/install.sh | sh
```
安装完成后,重启终端并执行下列命令即可安装 `Node.js`。
``` bash
nvm install node
$ nvm install node
```
### 安装 RSSHub
@@ -58,14 +58,14 @@ nvm install node
首先是下载 `RSSHub` 的源码,请执行下列命令。
``` bash
git clone https://github.com/DIYgod/RSSHub.git
cd RSSHub
$ git clone https://github.com/DIYgod/RSSHub.git
$ cd RSSHub
```
下载完成后,需要安装依赖。
``` bash
npm install
$ npm install
```
::: tip 提示
@@ -73,7 +73,7 @@ npm install
使用 `Yarn` 安装依赖时只需要键入
``` bash
yarn
$ yarn
```
由于众所周知的原因,在中国使用 `npm` 下载依赖十分缓慢,建议挂一个代理或者考虑使用 [NPM 镜像](https://npm.taobao.org/)。
@@ -83,8 +83,8 @@ yarn
在 `RSSHub` 文件夹中运行下面的命令就可以启动。
```
npm start
``` bash
$ npm start
```
在浏览器中打开 [http://127.0.0.1:1200/](http://127.0.0.1:1200/),enjoy it! ✅
@@ -96,13 +96,13 @@ Docker 属于 Linux 容器的一种封装,提供简单易用的容器使用接
运行下面的命令下载 RSSHub 镜像。
``` bash
docker pull diygod/rsshub
$ docker pull diygod/rsshub
```
然后运行 RSSHub 即可
``` bash
docker run -d --name rsshub -p 1200:1200 diygod/rsshub
$ docker run -d --name rsshub -p 1200:1200 diygod/rsshub
```
在浏览器中打开 [http://127.0.0.1:1200/](http://127.0.0.1:1200/),enjoy it! ✅
@@ -110,7 +110,7 @@ docker run -d --name rsshub -p 1200:1200 diygod/rsshub
您可以使用下面的命令来关闭 RSSHub。
``` bash
docker stop rsshub
$ docker stop rsshub
```
### 添加配置
@@ -120,31 +120,39 @@ docker stop rsshub
以设置缓存时间为1小时举例,只需要在运行时增加参数:`-e CACHE_EXPIRE=3600`
``` bash
docker run -d --name rsshub -p 1200:1200 -e CACHE_EXPIRE=3600 PORT=1000 diygod/rsshub
$ docker run -d --name rsshub -p 1200:1200 -e CACHE_EXPIRE=3600 PORT=1000 diygod/rsshub
```
更多配置项请看 [应用配置](#应用配置)
## 使用 docker-compose 部署
[docker-compose](https://docs.docker.com/compose/overview/) 是用来运行多容器 Docker 应用的小工具,可以简化配置部署过程:
1. 创建 volume 持久化 Redis 缓存
``` bash
docker volume create redis-data
$ docker volume create redis-data
```
2. 修改 `docker-compose.yml` 中的 `environment` 进行配置
2. 修改 [docker-compose.yml](https://github.com/DIYgod/RSSHub/blob/master/docker-compose.yml) 中的 `environment` 进行配置
3. 部署
``` bash
docker-compose up
$ docker-compose up
```
4. 更新
``` bash
docker-compose build
docker-compose up
$ docker-compose build
$ docker-compose up
```
## 部署到 Heroku
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https%3A%2F%2Fgithub.com%2FDIYgod%2FRSSHub)
[![Deploy](https://i.imgur.com/e6ZcmUY.png)](https://heroku.com/deploy?template=https%3A%2F%2Fgithub.com%2FDIYgod%2FRSSHub)
## 配置