Skip to content

Commit

Permalink
config & home.
Browse files Browse the repository at this point in the history
  • Loading branch information
datafl4sh committed Nov 20, 2024
1 parent d6ad319 commit b29e165
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 33 deletions.
18 changes: 13 additions & 5 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
title: Just the Docs Template
description: A starter template for a Jeykll site using the Just the Docs theme!
title: The wareHHOuse
description: The home of the DiSk++ and ProtoN computational codes
theme: just-the-docs

url: https://just-the-docs.github.io
baseurl: ""
url: https://wareHHOuse.github.io

permalink: pretty

defaults:
- scope:
path: "docs"
type: "pages"
values:
layout: "default"

aux_links:
Template Repository: https://github.com/just-the-docs/just-the-docs-template
30 changes: 2 additions & 28 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,9 @@
---
title: Home
layout: home
nav_order: 1
---

This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages]the [README] file explains how to do that, along with other details.
This is the home of DiSk++ and ProtoN, two numerical codes for the fast prototyping of polyhedral numerical methods for Partial Differential Equations.

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.[^1] 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 this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.

[Browse our documentation][Just the Docs] to learn more about how to use this theme.

To get started with creating a site, simply:

1. click "[use this template]" to create a GitHub repository
2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions

If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.

----

[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).

[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
[GitHub Pages]: https://docs.github.com/en/pages
[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
[Jekyll]: https://jekyllrb.com
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate

0 comments on commit b29e165

Please sign in to comment.