thang
/
notes
mirror of https://github.com/thangisme/notes.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
550 Commits 1 Branch 0 Tags 7.5 MiB
CSS 54.5%
HTML 21.4%
JavaScript 17%
Ruby 6.4%
Liquid 0.3%
Other 0.4%
Go to file
Silvio Giebl e2e01effa6 Add fuzzy search if no results were found 2020-01-03 22:44:04 +01:00
.github Add publishing workflow (#172) 2019-08-09 22:33:42 -04:00
_includes Prefixed svg ids to not clash with normal ids 2019-12-01 15:51:48 +01:00
_layouts Added search.button configuration 2019-12-29 21:30:44 +01:00
_sass Fixed stylelint 2020-01-03 08:58:38 +01:00
assets Add fuzzy search if no results were found 2020-01-03 22:44:04 +01:00
bin Make spacing consistent 2019-01-14 14:43:16 -05:00
docs Multi search match highlight 2020-01-02 11:55:38 +01:00
lib/tasks Update search.rake 2019-09-10 11:29:10 -04:00
script No longer need this build process 2018-11-15 15:49:41 -05:00
.gitignore Revert "Update .gitignore" 2019-08-29 14:45:09 +02:00
.stylelintrc.json exclude dark mode manifest 2018-11-18 11:09:18 -05:00
404.html Moved config search_tokenizer_separator -> search.tokenizer_separator 2019-12-29 20:08:34 +01: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
LICENSE.txt Initial commit 2017-03-09 13:16:08 -05:00
README.md Update README.md 2019-09-10 11:39:30 -04:00
Rakefile Add rakefile 2017-06-04 17:54:54 -04:00
_config.yml Multi search match highlight 2020-01-02 11:55:38 +01:00
favicon.ico Favicon file 2019-05-13 16:40:14 -04:00
index.md Update index.md 2019-09-10 12:19:29 -04:00
just-the-docs.gemspec Update just-the-docs.gemspec 2019-09-10 12:46:05 -04:00
package-lock.json Merge pull request #214 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-8.0.0 2019-09-10 12:05:14 -04:00
package.json Update package.json 2019-09-10 12:45:35 -04:00

README.md

Gem version Build status



Just the Docs

A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages with few dependencies.

See it in action!




jtd

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.

Submitting code changes:

  • Open a Pull Request
  • Ensure all CI tests pass
  • Await code review
  • Bump the version number in just-the-docs.gemspec and package.json according to semantic versioning.

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.

Your theme is set up 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.

License

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