thang/notes
1
0
Fork 0
mirror of https://github.com/thangisme/notes.git synced 2024-11-19 05:25:54 -05:00
Code Issues Projects Releases Wiki Activity
105 Commits 1 Branch 0 Tags 7.6 MiB
CSS 54.5%
HTML 21.4%
JavaScript 17%
Ruby 6.4%
Liquid 0.3%
Other 0.4%
deb9a2d945
Go to file
Patrick Marsceill deb9a2d945
Just the Docs build packaging cleanup
2018-10-23 11:42:58 -04:00
_includes Fix assets 2018-10-22 17:17:46 -04:00
_layouts Tidy up nav and search on mobile 2018-10-23 11:39:30 -04:00
_sass Just the Docs build packaging cleanup 2018-10-23 11:42:58 -04:00
assets Show / hide search with mobile nav 2018-10-23 11:41:25 -04:00
bin Add binary 2017-06-09 10:15:15 -04:00
docs getting this on GH 2017-11-08 11:23:05 -05:00
lib/tasks remove that 2017-06-12 18:45:25 -04:00
node_modules Initial commit 2017-03-09 13:16:08 -05:00
script fix build script 2017-04-09 16:09:24 -04:00
_config.yml Tidy up nav and search on mobile 2018-10-23 11:39:30 -04:00
.gitignore Initial commit 2017-03-09 13:16:08 -05:00
.stylelintrc.json Initial commit 2017-03-09 13:16:08 -05:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2018-10-22 13:07:17 -04:00
Gemfile Initial commit 2017-03-09 13:16:08 -05:00
index.md Make these buttons bigger, especially on mobile 2018-10-23 11:41:40 -04:00
just-the-docs.gemspec bump gem version 2018-10-23 11:42:37 -04:00
LICENSE.txt Initial commit 2017-03-09 13:16:08 -05:00
package.json Initial commit 2017-03-09 13:16:08 -05:00
Rakefile Add rakefile 2017-06-04 17:54:54 -04:00
README.md Update README.md 2018-10-22 13:33:56 -04:00
search-data.json I forget 2017-06-04 17:50:01 -04:00

README.md

Just the Docs

A nice looking, high customizable, responsive Jekyll theme for documention with built-in search. Easily hosted on GitHub pages.

screenshot 2018-10-22 11 36 56

Installation

Add this line to your Jekyll site's Gemfile:

gem "just-the-docs"

And add this line to your Jekyll site's _config.yml:

theme: just-the-docs

And then execute:

$ bundle

Or install it yourself as:

$ gem install just-the-docs

Usage

View the documentation for usage information.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When the theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.

When your changes are ready:

  • Open a Pull Request
  • Await code review
  • Bump the version number in just-the-docs.gemspec
  • Run script/build to package the gem
  • Run gem push just-the-docs-<version>.gem to publish the gem to Rubygems.org

License

The theme is available as open source under the terms of the MIT License.