Skip to content

Commit

Permalink
Adapted the website to just docs theme
Browse files Browse the repository at this point in the history
  • Loading branch information
FriskTheFallenHuman committed Feb 25, 2024
1 parent 829f5b9 commit 4c18710
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 120 deletions.
4 changes: 3 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ description: >- # this means to ignore newlines until "baseurl:"
Do you want to do x thing in Idtech4?, do you happen to not find
What you want?, Look no more, i hate when information is lost
so i made this page to save has much information has i can.
logo: "/assets/IdTech4_Logo.svg"
color_scheme: dark

gh_edit_repository: "https://github.com/FriskTheFallenHuman/idtecharchives"

baseurl: "" # the subpath of your site, e.g. /blog
url: https://friskthefallenhuman.github.io/idtecharchives/ # the base hostname & protocol for your site, e.g. http://example.com
Expand Down
35 changes: 35 additions & 0 deletions _pages/index.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Home
layout: home
---

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.

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
29 changes: 0 additions & 29 deletions _posts/2024-02-24-welcome-to-jekyll.markdown

This file was deleted.

18 changes: 0 additions & 18 deletions about.markdown

This file was deleted.

66 changes: 0 additions & 66 deletions assets/IdTech4_Logo.svg

This file was deleted.

6 changes: 0 additions & 6 deletions index.markdown

This file was deleted.

0 comments on commit 4c18710

Please sign in to comment.