File tree Expand file tree Collapse file tree 1 file changed +24
-2
lines changed Expand file tree Collapse file tree 1 file changed +24
-2
lines changed Original file line number Diff line number Diff line change 1- # [ railsdoc.github.io] ( https://railsdoc.github.io/ )
1+ # [ railsdoc.github.io] ( https://railsdoc.github.io/ )
22
33[ ![ CI] ( https://github.com/railsdoc/railsdoc.github.io/actions/workflows/ci.yml/badge.svg )] ( https://github.com/railsdoc/railsdoc.github.io/actions/workflows/ci.yml )
44[ ![ Deploy] ( https://github.com/railsdoc/railsdoc.github.io/actions/workflows/deploy.yml/badge.svg )] ( https://github.com/railsdoc/railsdoc.github.io/actions/workflows/deploy.yml )
55[ ![ Netlify Status] ( https://api.netlify.com/api/v1/badges/c964029a-6d5a-4f3a-95e9-d35830a2fe83/deploy-status )] ( https://app.netlify.com/sites/railsdoc-preview/deploys )
66
7- railsdoc.github.io is yet another Rails API documentation website.
7+ [ railsdoc.github.io] ( https://railsdoc.github.io/ ) is yet another Rails API documentation website.
88
99## Project Goal
1010
@@ -24,6 +24,28 @@ There are some enhancements in addition to SEO.
2424- [ ] Comment System
2525- [ ] etc. (see. https://github.com/railsdoc/railsdoc.github.io/issues )
2626
27+ ## Setup
28+
29+ ``` console
30+ $ bundle install
31+ ```
32+
33+ ## Build docs
34+
35+ ``` console
36+ $ rake build
37+ ```
38+
39+ This command generates Rails docs with ` default_rails_version ` defined in ` _config.yml ` .
40+
41+ ## Serve docs
42+
43+ Serve html under ` src ` directory.
44+
45+ ``` console
46+ $ bundle exec jekyll server
47+ ```
48+
2749## Docker Usage
2850
2951You can run this project using Docker Compose:
You can’t perform that action at this time.
0 commit comments