From 4c187103800c6e6087a60a875dd94fdbac657f5d Mon Sep 17 00:00:00 2001 From: Krispy Date: Sat, 24 Feb 2024 22:14:21 -0500 Subject: [PATCH] Adapted the website to just docs theme --- _config.yml | 4 +- _pages/index.markdown | 35 +++++++++++ _posts/2024-02-24-welcome-to-jekyll.markdown | 29 --------- about.markdown | 18 ------ assets/IdTech4_Logo.svg | 66 -------------------- index.markdown | 6 -- 6 files changed, 38 insertions(+), 120 deletions(-) create mode 100644 _pages/index.markdown delete mode 100644 _posts/2024-02-24-welcome-to-jekyll.markdown delete mode 100644 about.markdown delete mode 100644 assets/IdTech4_Logo.svg delete mode 100644 index.markdown diff --git a/_config.yml b/_config.yml index 949ba5e..eeb3157 100644 --- a/_config.yml +++ b/_config.yml @@ -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 diff --git a/_pages/index.markdown b/_pages/index.markdown new file mode 100644 index 0000000..ca0c545 --- /dev/null +++ b/_pages/index.markdown @@ -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 diff --git a/_posts/2024-02-24-welcome-to-jekyll.markdown b/_posts/2024-02-24-welcome-to-jekyll.markdown deleted file mode 100644 index ae65082..0000000 --- a/_posts/2024-02-24-welcome-to-jekyll.markdown +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: post -title: "Welcome to Jekyll!" -date: 2024-02-24 20:09:02 -0500 -categories: jekyll update ---- -You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. - -Jekyll requires blog post files to be named according to the following format: - -`YEAR-MONTH-DAY-title.MARKUP` - -Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works. - -Jekyll also offers powerful support for code snippets: - -{% highlight ruby %} -def print_hi(name) - puts "Hi, #{name}" -end -print_hi('Tom') -#=> prints 'Hi, Tom' to STDOUT. -{% endhighlight %} - -Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk]. - -[jekyll-docs]: https://jekyllrb.com/docs/home -[jekyll-gh]: https://github.com/jekyll/jekyll -[jekyll-talk]: https://talk.jekyllrb.com/ diff --git a/about.markdown b/about.markdown deleted file mode 100644 index 8b4e0b2..0000000 --- a/about.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: About -permalink: /about/ ---- - -This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/) - -You can find the source code for Minima at GitHub: -[jekyll][jekyll-organization] / -[minima](https://github.com/jekyll/minima) - -You can find the source code for Jekyll at GitHub: -[jekyll][jekyll-organization] / -[jekyll](https://github.com/jekyll/jekyll) - - -[jekyll-organization]: https://github.com/jekyll diff --git a/assets/IdTech4_Logo.svg b/assets/IdTech4_Logo.svg deleted file mode 100644 index a9d6f72..0000000 --- a/assets/IdTech4_Logo.svg +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - - - 4 - - - - diff --git a/index.markdown b/index.markdown deleted file mode 100644 index 0671507..0000000 --- a/index.markdown +++ /dev/null @@ -1,6 +0,0 @@ ---- -# Feel free to add content and custom Front Matter to this file. -# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults - -layout: home ----