Link Search Menu Expand Document
Relay Impact

Making Emerging Tech Accessible

Documenting resources and best practices for building emerging tech applications using open-source data, code and tools

Get started now View it on GitHub

Getting Started With Emerging Tech Applications

Verticals Covered

Just the Docs is built for Jekyll, a static site generator. View the quick start guide for more information. Just the Docs requires no special plugins and can run on GitHub Pages’ standard Jekyll compiler. The Jekyll SEO Tag plugin is included by default (no need to run any special installation) to inject SEO and open graph metadata on docs pages. For information on how to configure SEO and open graph metadata visit the Jekyll SEO Tag usage guide.

Using this Resources on this Repository

  1. Add Just the Docs to your Jekyll site’s _config.yml as a remote theme
    remote_theme: pmarsceill/just-the-docs

    You must have GitHub Pages enabled on your repo, one or more Markdown files, and a _config.yml file. See an example repository

Local installation: Use the gem-based theme

  1. Install the Ruby Gem
    $ gem install just-the-docs

    # .. or add it to your your Jekyll site’s Gemfile
gem "just-the-docs"
  2. Add Just the Docs to your Jekyll site’s _config.yml
    theme: "just-the-docs"
  3. Optional: Initialize search data (creates search-data.json)
    $ bundle exec just-the-docs rake search:init
  4. Run you local Jekyll server
    $ jekyll serve

    # .. or if you're using a Gemfile (bundler)
$ bundle exec jekyll serve
  5. Point your web browser to http://localhost:4000

If you’re hosting your site on GitHub Pages, set up GitHub Pages and Jekyll locally so that you can more easily work in your development environment.

Configure Just the Docs

About the project

This blog is © 2021-2021 by Mini Lam.

Contributing

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

Thank you to the contributors of Relay Impact!

  • minilamnow

Code of Conduct

Relay Impact is committed to fostering a welcoming community.

View our Code of Conduct on our GitHub repository.