feat: add documentation for services and tutorials

- Create new markdown files for analytics services: Plausible and Umami
- Add networking services documentation for ZeroTier and Tailscale
- Introduce a tutorial on building a home theater with Jellyfin
- Update mkdocs.yml to include new navigation and theme settings

These additions improve the overall documentation by providing detailed
information on various services and tutorials, making it easier for
users to understand and utilize the project effectively.
This commit is contained in:
songtianlun 2025-04-24 10:06:40 +08:00
parent ee39f48a97
commit 9d8876c1b6
15 changed files with 109 additions and 0 deletions

0
docs/acknowledgements.md Normal file
View File

2
docs/blog/index.md Normal file
View File

@ -0,0 +1,2 @@
# Blog

View File

@ -0,0 +1,11 @@
---
title: Plausible Analytics
tags:
- Analytics
# - Self-hosted
- Docker
# - Privacy-focused
---
Plausible Analytics 是一款注重隐私的开源网站分析工具...

View File

0
docs/services/index.md Normal file
View File

View File

@ -0,0 +1,5 @@
# docs/services/networking/.meta.yml
tags:
- Networking
- Self-hosted

View File

View File

0
docs/tags.md Normal file
View File

0
docs/tutorials/index.md Normal file
View File

View File

@ -0,0 +1,18 @@
---
date: 2024-01-15 # 文章发布日期,必需
title: 如何搭建开源家庭影院 # 文章标题 (也可通过 H1 标题自动获取)
categories:
- 家庭影院
- 教程
tags:
- Jellyfin
- Docker
- Raspberry Pi
authors:
- john_doe # 作者 ID (需在.authors.yml 中定义)
---
# 如何搭建开源家庭影院
本文将介绍如何使用 Jellyfin...

View File

@ -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

9
package.json Normal file
View File

@ -0,0 +1,9 @@
{
"name": "mkdocs",
"version": "1.0.0",
"private": true,
"scripts": {
"dev": "mkdocs serve",
"build": "python3 -m mkdocs build -d public"
}
}

4
requirements.txt Normal file
View File

@ -0,0 +1,4 @@
mkdocs
#Add pip package if needed
#mkdocs-bootswatch
#mkdocs-minify-plugin