diff --git a/docs/main.py b/docs/main.py index 71f58fa7..e8e05282 100644 --- a/docs/main.py +++ b/docs/main.py @@ -24,7 +24,7 @@ def define_env(env: Any) -> None: autoPlay: true, controls: false, speed: 1.5, - theme: "alabaster-auto" + theme: "solarized-light" }}); """ diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 6557b5a7..53f4d73e 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: cLAN Documentation +site_name: cLAN Docs site_url: https://docs.clan.lol repo_url: https://git.clan.lol/clan/clan-core/ repo_name: clan-core @@ -90,7 +90,8 @@ docs_dir: site site_dir: out theme: - logo: static/logo.png + logo: static/clan-white.png + favicon: static/clan-dark.png name: material features: - navigation.instant @@ -122,10 +123,23 @@ theme: extra_javascript: - static/main.js + extra_css: - static/asciinema-player/custom-theme.css - static/asciinema-player/asciinema-player.css +extra: + social: + - icon: fontawesome/regular/comment + link: https://matrix.to/#/#clan:lassul.us + - icon: fontawesome/brands/gitlab + link: https://git.clan.lol/clan/clan-core + - icon: fontawesome/brands/github + link: https://github.com/clan-lol/clan-core + - icon: fontawesome/solid/rss + link: /feed_rss_created.xml + + plugins: - search - blog @@ -134,6 +148,7 @@ plugins: match_path: blog/posts/.* use_git: false date_from_meta: + title: "Clan Blog" as_creation: "date" as_update: "date" datetime_format: "%Y-%m-%d %H:%M" diff --git a/docs/site/blog/posts/2024-03-19-hello-world.md b/docs/site/blog/posts/hello-world.md similarity index 98% rename from docs/site/blog/posts/2024-03-19-hello-world.md rename to docs/site/blog/posts/hello-world.md index 01ea7b54..4764ea72 100644 --- a/docs/site/blog/posts/2024-03-19-hello-world.md +++ b/docs/site/blog/posts/hello-world.md @@ -65,7 +65,7 @@ Connect with us on our [Matrix channel at clan.lol](https://matrix.to/#/#clan:la Want to see the code? Check it out [on our Gitea](https://git.clan.lol/clan/clan-core) or [on GitHub](https://github.com/clan-lol/clan-core). -Or follow our RSS feed by clicking in the top right corner! +Or follow our [RSS feed](https://docs.clan.lol/feed_rss_created.xml)! Join us and be part of changing technology for the better, together. diff --git a/docs/site/blog/posts/2024-04-16-new-docs.md b/docs/site/blog/posts/new-docs.md similarity index 100% rename from docs/site/blog/posts/2024-04-16-new-docs.md rename to docs/site/blog/posts/new-docs.md diff --git a/docs/site/index.md b/docs/site/index.md index 551f2e7b..282cb907 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -1,19 +1,6 @@ # Getting Started -Welcome to your simple guide on starting a new Clan project. - -## What's Inside - -We've put together a straightforward guide to help you out: - -- [**Starting with a New Clan Project**](#starting-with-a-new-clan-project): Create a new Clan from scratch. -- [**Integrating Clan using Flake-Parts**](getting-started/flake-parts.md) - ---- - -## **Starting with a New Clan Project** - -Create your own clan with these initial steps. +Create your own clan with these initial steps and manage a fleet of machines with one single testable git repository! ### Prerequisites diff --git a/docs/site/static/clan-dark.png b/docs/site/static/clan-dark.png new file mode 100644 index 00000000..94364cd2 Binary files /dev/null and b/docs/site/static/clan-dark.png differ diff --git a/docs/site/static/clan-white.png b/docs/site/static/clan-white.png new file mode 100644 index 00000000..45361f1a Binary files /dev/null and b/docs/site/static/clan-white.png differ diff --git a/docs/site/static/logo.png b/docs/site/static/logo.png deleted file mode 100644 index 39298fb7..00000000 Binary files a/docs/site/static/logo.png and /dev/null differ