Skip to content

Commit 4701137

Browse files
authored
Update README.md (#21)
* Update README.md * Updating README * Update link
1 parent 53ffddd commit 4701137

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
11
# [railsdoc.github.io](https://railsdoc.github.io/)
22

33
[![Build Status](https://travis-ci.com/railsdoc/railsdoc.github.io.svg?branch=page-source)](https://travis-ci.com/railsdoc/railsdoc.github.io)
4+
5+
railsdoc.github.io is yet another Rails API documentation website.
6+
7+
## Project Goal
8+
9+
The project goal is **making [api.rubyonrails.org](https://api.rubyonrails.org/) SEO-friendly**.
10+
11+
### Additional Goals
12+
13+
Thare are some enhancements in addition to SEO.
14+
15+
- [x] Built by [Jekyll](https://github.com/jekyll/jekyll)
16+
- [x] Styled by [bootstrap(v4)](https://github.com/twbs/bootstrap)
17+
- [x] No iframe layout
18+
- [x] Table of Contents
19+
- [x] Google Custom Search
20+
- [ ] Mobile-friendly design
21+
- [ ] Multiple version documentation
22+
- [ ] etc. (see. https://github.com/railsdoc/railsdoc.github.io/issues)
23+
24+
## Feature Request
25+
26+
Please create an [issue](https://github.com/railsdoc/railsdoc.github.io/issues).

0 commit comments

Comments
 (0)