Skip to content

Latest commit

 

History

History
99 lines (67 loc) · 5.35 KB

index.md

File metadata and controls

99 lines (67 loc) · 5.35 KB
Raw
title layout nav_order description permalink
Home
home
1
Just the Docs is a responsive Jekyll theme with built-in search that is easily customizable and hosted on GitHub Pages.
/

Focus on writing good documentation

{: .fs-9 }

Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub Pages. {: .fs-6 .fw-300 }

Get started now{: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } View it on GitHub{: .btn .fs-5 .mb-4 .mb-md-0 }

{: .warning }

This website documents the features of the current main branch of the Just the Docs theme. See [the CHANGELOG]({% link CHANGELOG.md %}) for a list of releases, new features, and bug fixes.

Just the Docs is a theme for generating static websites with Jekyll. You can write source files for your web pages using Markdown, the Liquid templating language, and HTML.1 Jekyll builds your site by converting all files that have front matter to HTML. Your Jekyll configuration file determines which theme to use, and sets general parameters for your site, such as the URL of its home page.

Jekyll builds this Just the Docs theme docs website using the theme itself. These web pages show how your web pages will look by default when you use this theme. But you can easily [customize] the theme to make them look completely different!

Browse the docs to learn more about how to use this theme.

Getting started

The Just the Docs Template provides the simplest, quickest, and easiest way to create a new website that uses the Just the Docs theme. To get started with creating a site, just click "[use the template]"!

{: .note } To use the theme, you do not need to clone or fork the Just the Docs repo! You should do that only if you intend to browse the theme docs locally, contribute to the development of the theme, or develop a new theme based on Just the Docs.

You can easily set the site created by the template to be published on GitHub Pages – the template README file explains how to do that, along with other details.

If Jekyll is installed on your computer, you can also build and preview the created site locally. This lets you test changes before committing them, and avoids waiting for GitHub Pages.2 And you will be able to deploy your local build to a different platform than GitHub Pages.

More specifically, the created site:

  • uses a gem-based approach, i.e. uses a Gemfile and loads the just-the-docs gem
  • uses the GitHub Pages / Actions workflow to build and publish the site on GitHub Pages

Other than that, you're free to customize sites that you create with the template, however you like. You can easily change the versions of just-the-docs and Jekyll it uses, as well as adding further plugins.

{: .note } See the theme README for how to use the theme as a gem without creating a new site.

About the project

Just the Docs is © 2017-{{ "now" | date: "%Y" }} by Patrick Marsceill.

License

Just the Docs is distributed by an MIT license.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Read more about becoming a contributor in our GitHub repo.

Thank you to the contributors of Just the Docs!

    {% for contributor in site.github.contributors %}
  • {{ contributor.login }}
    • {% endfor %}

Code of Conduct

Just the Docs is committed to fostering a welcoming community.

View our Code of Conduct on our GitHub repository.

[customize]: {% link docs/customization.md %} [use the template]: https://github.com/just-the-docs/just-the-docs-template/generate

Footnotes

  1. The source file for this page uses all three markup languages. ↩

  2. It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub. ↩