Skip to content

A modern, high customizable, responsive Jekyll theme for documention with built-in search.

License

Notifications You must be signed in to change notification settings

Mi-Lan/dxDaoBlog

This branch is 117 commits ahead of, 460 commits behind just-the-docs/just-the-docs:main.

Folders and files

NameName
Last commit message
Last commit date
Oct 14, 2020
Mar 9, 2021
Mar 24, 2021
May 4, 2021
Mar 24, 2021
Aug 4, 2022
Jan 14, 2019
Oct 28, 2022
Aug 10, 2020
Nov 15, 2018
Mar 9, 2021
Feb 22, 2021
Apr 24, 2020
Apr 24, 2020
Apr 24, 2020
Aug 10, 2020
Oct 22, 2018
Jul 28, 2020
Aug 4, 2022
Mar 9, 2017
Jul 28, 2020
Jun 4, 2017
Nov 26, 2021
Feb 17, 2021
May 24, 2021
Feb 10, 2022
Dec 22, 2020
Jan 14, 2021
Oct 14, 2020
Dec 22, 2020

Repository files navigation

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

Alternatively, you can run it inside Docker while developing your site

$ docker-compose up

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.

About

A modern, high customizable, responsive Jekyll theme for documention with built-in search.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • SCSS 54.2%
  • HTML 21.8%
  • JavaScript 16.9%
  • Ruby 6.4%
  • Liquid 0.3%
  • Dockerfile 0.2%
  • Shell 0.2%