mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-08 04:51:23 -06:00
Update README.md
This commit is contained in:
parent
d8a90f70c1
commit
f92fd09a12
19
README.md
19
README.md
@ -1,10 +1,16 @@
|
||||
# Just the Docs [](https://badge.fury.io/rb/just-the-docs) [](https://travis-ci.com/pmarsceill/just-the-docs)
|
||||
<p align="right">
|
||||
<a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://travis-ci.com/pmarsceill/just-the-docs"><img src="https://travis-ci.com/pmarsceill/just-the-docs.svg?branch=master" alt="Build status"></a>
|
||||
</p>
|
||||
<br><br>
|
||||
<p align="center">
|
||||
<h1 align="center">Just the Docs</h1>
|
||||
<p align="center">A modern, high customizable, responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub pages with few dependencies.</p>
|
||||
<br><br><br>
|
||||
</p>
|
||||
|
||||
A nice looking, high customizable, responsive Jekyll theme for documentation with built-in search. Easily hosted on GitHub pages.
|
||||
|
||||

|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Add this line to your Jekyll site's Gemfile:
|
||||
@ -42,6 +48,13 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsc
|
||||
- Await code review
|
||||
- Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/).
|
||||
|
||||
### Design and development principles of this theme:
|
||||
|
||||
1. As few dependencies as possible
|
||||
2. No build script needed
|
||||
3. First class mobile experience
|
||||
4. Make the content shine
|
||||
|
||||
## Development
|
||||
|
||||
To set up your environment to develop this theme, run `bundle install`.
|
||||
|
Loading…
x
Reference in New Issue
Block a user