thang/notes
1
0
Fork 0
mirror of https://github.com/thangisme/notes.git synced 2024-11-10 12:56:05 -05:00
Code Issues Projects Releases Wiki Activity
75 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%
c817a4ea66
Go to file
Patrick Marsceill c817a4ea66
Just the Docs build packaging cleanup
2018-10-22 11:52:20 -04:00
_includes final shit for release 2017-04-08 18:51:14 -04:00
_layouts fix mobile nav 2018-10-22 11:52:13 -04:00
_sass Just the Docs build packaging cleanup 2018-10-22 11:52:20 -04:00
assets getting this on GH 2017-11-08 11:23:05 -05: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 getting this on GH 2017-11-08 11:23:05 -05:00
.gitignore Initial commit 2017-03-09 13:16:08 -05:00
.stylelintrc.json Initial commit 2017-03-09 13:16:08 -05:00
Gemfile Initial commit 2017-03-09 13:16:08 -05:00
index.md getting this on GH 2017-11-08 11:23:05 -05:00
just-the-docs.gemspec Add the Rakefile to the gemspec 2017-06-09 10:38:00 -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 Initial commit 2017-03-09 13:16:08 -05:00
search-data.json I forget 2017-06-04 17:50:01 -04:00

README.md

just-the-docs

Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in _layouts, your includes in _includes and your sass in _sass. To experiment with this code, add some sample content and run bundle exec jekyll serve – this directory is setup just like a Jekyll site!

TODO: Delete this and the text above, and describe your gem

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

TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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 your theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.

License

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