Skip to content

Commit e8396e9

Browse files
committed
docs: Gitbook note, and local installation steps corrected
1 parent a457e3f commit e8396e9

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
44

55
## What is it
6-
A simple Rails app with Devise authentication to serve static docs generated with a tool like [MkDocs](http://www.mkdocs.org/).
6+
A simple Rails app with Devise authentication to serve static docs generated with a tool like
7+
[MkDocs](http://www.mkdocs.org/) or [Gitbook](https://toolchain.gitbook.com).
78
Static html is served by [HighVoltage](https://github.com/thoughtbot/high_voltage) customized to serve pathes
8-
containing whitespaces and dir pathes missing 'index' filename. [RailsAdmin](https://github.com/sferik/rails_admin) is used for users administration.
9+
containing whitespaces and dir pathes missing 'index' filename. [RailsAdmin](https://github.com/sferik/rails_admin) is
10+
used for users administration.
911

1012
## Usage
1113
This assumes you have a docs-building project in Git, the built docs are in 'site' directory and you want to deploy it
@@ -54,7 +56,8 @@ gem install bundler
5456
bundle install
5557
```
5658
* Install NPM dependencies: `npm install`
57-
* generate site docs to some dir like 'site'
59+
* generate site docs to './site' dir
60+
* change Gulpfile.js to have `const TARGET_DIR = '.'` - the default value there is for prod usage
5861
* copy the docs pages to relevant dirs: `./node_modules/.bin/gulp prepare`
5962
* run local webserver:
6063
```

0 commit comments

Comments
 (0)