Merge pull request #255 from stavros-k/rework

Rework

.gitignore

@@ -18,4 +18,3 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-.obsidian

README.md

@@ -2,6 +2,6 @@
 
 PR's are always welcome, to add, improve or even correct things.
 
-I'm no expert on anything here. SO use at your own risk
+I'm no expert on anything here. So use at your own risk
 
 This is just some docs I wrote myself for things I've done over the years.

blog/2023-12-10_initial.md

@@ -0,0 +1,4 @@
+---
+title: Initial
+authors: stavros-k
+---

blog/authors.yml

@@ -0,0 +1,5 @@
+stavros-k:
+  name: Stavros Kois
+  title: Owner of Stavros' Docs
+  url: https://github.com/stavros-k
+  image_url: https://github.com/stavros-k.png

config/localSearchTheme.ts

@@ -0,0 +1,15 @@
+import type { PluginConfig } from "@docusaurus/types";
+
+export const localSearch: PluginConfig = [
+  // https://github.com/easyops-cn/docusaurus-search-local?tab=readme-ov-file#theme-options
+  require.resolve("@easyops-cn/docusaurus-search-local"),
+  {
+    docsRouteBasePath: "/",
+    docsDir: "docs",
+    blogRouteBasePath: "/blog",
+    blogDir: "blog",
+    indexBlog: true,
+    indexDocs: true,
+    hashed: true,
+  },
+];

config/presetOptions.ts

@@ -0,0 +1,26 @@
+import type { Options } from "@docusaurus/preset-classic";
+
+import type {PluginOptions } from "@docusaurus/plugin-sitemap";
+
+export const classicPresetOptions: Options = {
+  pages: false,
+  docs: {
+    routeBasePath: "/",
+    sidebarPath: "./sidebars.ts",
+    showLastUpdateTime: true,
+    editUrl: "https://github.com/stavros-k/docs/tree/master/",
+  },
+  blog: {
+    showReadingTime: true,
+    routeBasePath: "/blog",
+    editUrl: "https://github.com/stavros-k/docs/tree/master/"
+  },
+  theme: {
+    customCss: "./src/css/custom.css",
+  },
+  sitemap: <PluginOptions> {
+    priority: 1,
+    filename: "sitemap.xml",
+    changefreq: 'weekly',
+  }
+}

config/themesConfig.ts

@@ -0,0 +1,82 @@
+import type { ThemeConfig } from "@docusaurus/preset-classic";
+import { themes } from "prism-react-renderer";
+import { zoomConfig } from "./zoomPlugin";
+
+export const themesConfig: ThemeConfig = {
+  copyright: `Copyright © ${new Date().getFullYear()} Stavros' Docs, Built with Docusaurus.`,
+  docs: {
+    sidebar: {
+      autoCollapseCategories: true,
+      hideable: true,
+    },
+  },
+  ...zoomConfig,
+  prism: {
+    theme: themes.github,
+    darkTheme: themes.dracula,
+  },
+  navbar: {
+    title: "Stavros' Docs",
+    logo: {
+      alt: "Dinosaur Logo",
+      src: "./img/logo.svg",
+    },
+    items: [
+      {
+        type: "doc",
+        docId: "index",
+        position: "left",
+        label: "Documentation",
+        to: "/",
+      },
+      {
+        docId: "blog",
+        label: "Blog",
+        position: "left",
+        to: "/blog",
+      },
+      {
+        href: "https://github.com/stavros-k/docs",
+        label: "GitHub",
+        position: "right",
+      },
+    ],
+  },
+  footer: {
+    style: "dark",
+    links: [
+      {
+        title: "Docs",
+        items: [
+          {
+            label: "Documentation",
+            to: "/",
+          },
+        ],
+      },
+      {
+        title: "Social",
+        items: [
+          {
+            label: "GitHub",
+            href: "https://github.com/stavros-k/docs",
+          },
+          {
+          label: "Twitter",
+            href: "https://twitter.com/stavroskois",
+          },
+        ],
+      },
+      {
+        title: "More",
+        items: [
+          {
+            label: "Blog",
+            to: "/blog",
+          },
+        ],
+      },
+    ],
+  },
+
+};

config/zoomPlugin.ts

@@ -0,0 +1,21 @@
+import type { PluginConfig } from "@docusaurus/types";
+
+export const imageZoom: PluginConfig = [
+  require.resolve("docusaurus-plugin-image-zoom"),
+  {},
+];
+
+// https://github.com/francoischalifour/medium-zoom?tab=readme-ov-file#options
+export const zoomConfig = {
+  zoom: {
+    selector: ".markdown :not(em) > img",
+    config: {
+      margin: 100,
+      scrollOffset: 40,
+      background: {
+        light: "rgb(255, 255, 255)",
+        dark: "rgb(50, 50, 50)",
+      },
+    },
+  },
+}

cspell.config.yaml

@@ -11,6 +11,7 @@ words:
   - bindkey
   - browserslist
   - Bubuntu
+  - changefreq
   - clsx
   - CNAME
   - configd

docs/home-automation/esp-home/index.md

@@ -0,0 +1,4 @@
+---
+title: ESP Home
+sidebar_position: 1
+---

docs/home-automation/1-esp-home/1-xiaomi-thermometere-LYWSD03MMC.md → docs/home-automation/esp-home/xiaomi-thermometere-LYWSD03MMC.md

@@ -1,4 +1,7 @@
-# Xiaomi Thermometer LYWSD03MMC
+---
+title: Xiaomi Thermometer LYWSD03MMC
+sidebar_position: 1
+---
 
 ## Flash firmware
 

docs/home-automation/index.md

@@ -1,3 +1,6 @@
-# Home Automation
+---
+title: Home Automation
+sidebar_position: 5
+---
 
 This section will include guides around home automation

docs/index.md

@@ -0,0 +1,10 @@
+---
+title: Home
+sidebar_position: 1
+---
+
+This is a personal documentation site, generated with Docusaurus.
+
+If you find anything wrong or missing, you can always open a PR.
+
+You can find the repository of these docs are, [here](https://github.com/stavros-k/docs)

docs/networking/index.md

@@ -1,3 +1,6 @@
-# Networking
+---
+title: Networking
+sidebar_position: 2
+---
 
 This section will include guides around networking.

docs/networking/2-opnsense/7-automatic-backups/2-configuration.md → docs/networking/opnsense/automatic-backups/configuration.md

@@ -1,4 +1,7 @@
-# Configuration
+---
+title: Configuration
+sidebar_position: 2
+---
 
 Navigate to `System` > `Configuration` > `Backups`
 

docs/networking/2-opnsense/7-automatic-backups/index.md → docs/networking/opnsense/automatic-backups/index.md

@@ -1,4 +1,7 @@
-# Automatic Backups
+---
+title: Automatic Backups
+sidebar_position: 7
+---
 
 You can configure **daily** automatic backups to Nextcloud.
 

docs/networking/2-opnsense/7-automatic-backups/1-installation.md → docs/networking/opnsense/automatic-backups/installation.md

@@ -1,4 +1,7 @@
-# Installation
+---
+title: Installation
+sidebar_position: 1
+---
 
 Navigate to `System` > `Firmware` > `Plugins`
 

docs/networking/2-opnsense/4-dhcp/2-boot-wds.md → docs/networking/opnsense/dhcp/boot-wds.md

@@ -1,4 +1,7 @@
-# Boot from WDS
+---
+title: Boot from WDS
+sidebar_position: 2
+---
 
 If you have a [WDS](https://docs.microsoft.com/en-us/windows/win32/wds/windows-deployment-services-portal)
 on your network you might notice that VLANs or networks not in the same range (sometimes in the same range also)

docs/networking/2-opnsense/4-dhcp/1-configuration.md → docs/networking/opnsense/dhcp/configuration.md

@@ -1,4 +1,7 @@
-# Configuration
+---
+title: Configuration
+sidebar_position: 1
+---
 
 Navigate to `Services` -> `DHCPv4` -> `[LAN]*`
 

docs/networking/2-opnsense/4-dhcp/index.md → docs/networking/opnsense/dhcp/index.md

@@ -1,4 +1,7 @@
-# DHCP
+---
+title: DHCP
+sidebar_position: 4
+---
 
 DHCP assigns IP addresses to new clients connecting to the network.
 

docs/networking/opnsense/dns/index.md

@@ -0,0 +1,4 @@
+---
+title: DNS
+sidebar_position: 6
+---

docs/networking/2-opnsense/6-dns/1-resolver/1-configuration.md → docs/networking/opnsense/dns/resolver/configuration.md

@@ -1,4 +1,7 @@
-# Configuration
+---
+title: Configuration
+sidebar_position: 1
+---
 
 ## Settings
 

docs/networking/opnsense/dns/resolver/index.md

@@ -0,0 +1,4 @@
+---
+title: DNS Resolver
+sidebar_position: 1
+---

docs/networking/2-opnsense/8-dynamic-dns/2-configuration.md → docs/networking/opnsense/dynamic-dns/configuration.md

@@ -1,4 +1,7 @@
-# Configuration
+---
+title: Configuration
+sidebar_position: 2
+---
 
 :::tip
 

docs/networking/2-opnsense/8-dynamic-dns/index.md → docs/networking/opnsense/dynamic-dns/index.md

@@ -1,4 +1,7 @@
-# Dynamic DNS
+---
+title: Dynamic DNS
+sidebar_position: 8
+---
 
 Most home labs does not have a static IP address. In order to have your domain always
 pointing to your current public IP address, you have to use a Dynamic DNS service.

docs/networking/2-opnsense/8-dynamic-dns/1-installation.md → docs/networking/opnsense/dynamic-dns/installation.md

@@ -1,4 +1,7 @@
-# Installation
+---
+title: Installation
+sidebar_position: 1
+---
 
 Navigate to `System` > `Firmware` > `Plugins`
 

docs/networking/2-opnsense/9-firewall/2-aliases.md → docs/networking/opnsense/firewall/aliases.md

@@ -1,4 +1,7 @@
-# Aliases
+---
+title: Aliases
+sidebar_position: 2
+---
 
 You can create Aliases, grouping multiple IPs, Ports, URLS, etc
 making it easier to apply rules to them later.

docs/networking/2-opnsense/9-firewall/4-antiddos.md → docs/networking/opnsense/firewall/antiddos.md

@@ -1,4 +1,7 @@
-# Anti DDOS
+---
+title: Anti DDOS
+sidebar_position: 4
+---
 
 When syncookies are active, OPNSense will answer each incoming TCP SYN with a syncookie SYNACK,
 **without** allocating any resources.

docs/networking/2-opnsense/9-firewall/3-firewall-nat.md → docs/networking/opnsense/firewall/firewall-nat.md

@@ -1,4 +1,7 @@
-# Firewall & NAT
+---
+title: Firewall & NAT
+sidebar_position: 3
+---
 
 When you want to reach a service hosted in the same network via it's FQDN,
 you have to either user `Split DNS` or enable `NAT Reflection` (also known as NAT Hairpinning).
@@ -11,8 +14,8 @@ when using internal services, but requires an entry for each service.
 
 ## Split DNS
 
-- Setup [Unbound DNS](../6-dns/1-resolver/1-configuration.md)
-- (Optional) Setup [Force DNS Redirection](1-redirect-dns.md)
+- Setup [Unbound DNS](../dns/resolver/configuration.md)
+- (Optional) Setup [Force DNS Redirection](redirect-dns.md)
 
 :::tip
 

docs/networking/opnsense/firewall/index.md

@@ -0,0 +1,4 @@
+---
+title: Firewall
+sidebar_position: 9
+---