thang/notes
1
0
Fork 0
mirror of https://github.com/thangisme/notes.git synced 2024-11-17 23:56:04 -05:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Patrick Marsceill 2018-10-26 11:27:56 -04:00 committed by GitHub
parent d8a90f70c1
commit f92fd09a12
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,10 +1,16 @@
# Just the Docs [![Gem Version](https://badge.fury.io/rb/just-the-docs.svg)](https://badge.fury.io/rb/just-the-docs) [![Build Status](https://travis-ci.com/pmarsceill/just-the-docs.svg?branch=master)](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.
![jtd](https://user-images.githubusercontent.com/896475/47384541-89053c80-d6d5-11e8-98dc-dba16e192de9.gif)
## 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`.