diff --git a/docs/acknowledgements.md b/docs/acknowledgements.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/blog/index.md b/docs/blog/index.md new file mode 100644 index 0000000..c58f16c --- /dev/null +++ b/docs/blog/index.md @@ -0,0 +1,2 @@ +# Blog + diff --git a/docs/services/analytics/plausible.md b/docs/services/analytics/plausible.md new file mode 100644 index 0000000..8be88bb --- /dev/null +++ b/docs/services/analytics/plausible.md @@ -0,0 +1,11 @@ +--- +title: Plausible Analytics +tags: + - Analytics + # - Self-hosted + - Docker + # - Privacy-focused +--- + +Plausible Analytics 是一款注重隐私的开源网站分析工具... + diff --git a/docs/services/analytics/umami.md b/docs/services/analytics/umami.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/services/index.md b/docs/services/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/services/networking/.meta.yml b/docs/services/networking/.meta.yml new file mode 100644 index 0000000..e138c9c --- /dev/null +++ b/docs/services/networking/.meta.yml @@ -0,0 +1,5 @@ +# docs/services/networking/.meta.yml +tags: + - Networking + - Self-hosted + diff --git a/docs/services/networking/tailscale.md b/docs/services/networking/tailscale.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/services/networking/zerotier.md b/docs/services/networking/zerotier.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/tags.md b/docs/tags.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/tutorials/posts/build-home-theater.md b/docs/tutorials/posts/build-home-theater.md new file mode 100644 index 0000000..440a4ac --- /dev/null +++ b/docs/tutorials/posts/build-home-theater.md @@ -0,0 +1,18 @@ +--- +date: 2024-01-15 # 文章发布日期，必需 +title: 如何搭建开源家庭影院 # 文章标题 (也可通过 H1 标题自动获取) +categories: + - 家庭影院 + - 教程 +tags: + - Jellyfin + - Docker + - Raspberry Pi +authors: + - john_doe # 作者 ID (需在.authors.yml 中定义) +--- + +# 如何搭建开源家庭影院 + +本文将介绍如何使用 Jellyfin... + diff --git a/docs/tutorials/posts/setup-k3s-cluster.md b/docs/tutorials/posts/setup-k3s-cluster.md new file mode 100644 index 0000000..e69de29 diff --git a/mkdocs.yml b/mkdocs.yml index ef1b2ff..05d7cb2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,64 @@ +# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json site_name: SelfHost-Hub site_url: https://selfhost-hub.com theme: name: material + language: zh + palette: + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + - scheme: default # 浅色模式配置 + media: "(prefers-color-scheme: light)" + primary: brown + accent: deep orange + toggle: # 切换按钮配置 + icon: material/weather-night + name: 切换到深色模式 + - scheme: slate # 深色模式配置 + media: "(prefers-color-scheme: dark)" + primary: black + accent: deep purple + toggle: + icon: material/weather-sunny + name: 切换到浅色模式 + features: + # 启用 Section Index Pages 功能 。这允许将一个 index.md 文件直接关联到一个导航分区 + - navigation.indexes +plugins: + - tags + - blog + - rss: + match_path: tutorials/posts/.* # 仅包含教程/博客文章 + date_from_meta: + as_creation: date # 使用文章的 date front matter 作为发布日期 + categories: # 在 feed 中包含分类和标签 + - categories + - tags +extra: + alternate: + - name: 简体中文 + link: / + lang: zh + - name: English + link: /en/ + lang: en +nav: + - 首页: index.md + - 服务: + - services/index.md # 服务板块索引页 + - 分析工具: + - services/analytics/index.md # 分类索引页 (可选) + - Plausible: services/analytics/plausible.md + - Umami: services/analytics/umami.md + - 网络工具: + - services/networking/index.md # 分类索引页 (可选) + - ZeroTier: services/networking/zerotier.md + - Tailscale: services/networking/tailscale.md + - 教程与博客: + - tutorials/index.md # 博客索引页 (通常由 blog 插件自动处理) + - 搭建家庭影院: tutorials/posts/build-home-theater.md + - 标签索引: tags.md + - 致谢: acknowledgements.md diff --git a/package.json b/package.json new file mode 100644 index 0000000..d626dd2 --- /dev/null +++ b/package.json @@ -0,0 +1,9 @@ +{ + "name": "mkdocs", + "version": "1.0.0", + "private": true, + "scripts": { + "dev": "mkdocs serve", + "build": "python3 -m mkdocs build -d public" + } +} diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..5b5156e --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +mkdocs +#Add pip package if needed +#mkdocs-bootswatch +#mkdocs-minify-plugin