From a2574690f1f2660bf5b36d3886a7f0489724d342 Mon Sep 17 00:00:00 2001 From: Florian Weber Date: Sun, 29 Dec 2024 21:57:07 +0100 Subject: [PATCH] some basic changes --- .gitea/workflows/pages-deploy.yaml | 2 +- _config.yml | 7 ++++-- index.md | 34 ++++++------------------------ 3 files changed, 13 insertions(+), 30 deletions(-) diff --git a/.gitea/workflows/pages-deploy.yaml b/.gitea/workflows/pages-deploy.yaml index 8952ec6..38d405f 100644 --- a/.gitea/workflows/pages-deploy.yaml +++ b/.gitea/workflows/pages-deploy.yaml @@ -50,7 +50,7 @@ jobs: source /etc/profile.d/rvm.sh && \ rvm use $RUBY_VERSION && ruby -v && gem -v && \ bundle install && \ - bundle exec jekyll build --destination pages + bundle exec jekyll build --destination pages env: JEKYLL_ENV: production - name: push pages diff --git a/_config.yml b/_config.yml index b54965e..55ee41e 100644 --- a/_config.yml +++ b/_config.yml @@ -7,5 +7,8 @@ baseurl: "/" url: "https://illuvia.world" show_downloads: false -aux_links: - Template Repository: https://github.com/just-the-docs/just-the-docs-template +nav_external_links: + - title: Impressum + url: https://legal.thephoenixdi.vision + hide_icon: true + opens_in_new_tab: true diff --git a/index.md b/index.md index ca0c545..d3acef5 100644 --- a/index.md +++ b/index.md @@ -3,33 +3,13 @@ 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. +# +{: .fs-9 } -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. +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 } -More specifically, the created site: +[Get started now](#getting-started){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } +[View it on GitHub][Just the Docs repo]{: .btn .fs-5 .mb-4 .mb-md-0 } -- 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 +---