nixos-and-flakes-book/docs/.vitepress/config.ts

470 lines
14 KiB
TypeScript
Raw Normal View History

2023-06-30 09:29:38 +02:00
import { generateSitemap as sitemap } from "sitemap-ts";
import { PageData, defineConfig } from "vitepress";
// https://vitepress.dev/reference/site-config
export default defineConfig({
2023-06-30 09:29:38 +02:00
// remove trailing `.html`
// https://vitepress.dev/guide/routing#generating-clean-url
cleanUrls: true,
// Whether to get the last updated timestamp for each page using Git.
lastUpdated: true,
2023-06-30 09:29:38 +02:00
// SEO Improvement - sitemap.xml & robots.txt
2023-06-30 06:11:27 +02:00
buildEnd: async ({ outDir }) => {
2023-06-30 09:29:38 +02:00
sitemap({
2023-06-30 06:11:27 +02:00
hostname: "https://nixos-and-flakes.thiscute.world/",
2023-06-30 09:29:38 +02:00
outDir: outDir,
generateRobotsTxt: true,
2023-06-30 06:11:27 +02:00
});
},
// SEO Improvement - JSON-LD
transformPageData(pageData) {
return {
frontmatter: {
...pageData.frontmatter,
head: [
["script", { type: "application/ld+json" }, getJSONLD(pageData)],
],
},
};
},
2023-06-30 06:11:27 +02:00
// markdown options
2023-06-23 16:41:34 +02:00
markdown: {
theme: "material-theme-palenight",
lineNumbers: true,
2023-06-23 19:23:37 +02:00
config: (md) => {
// add support for footnote
2023-06-23 19:23:37 +02:00
md.use(require("markdown-it-footnote"));
2023-06-23 16:41:34 +02:00
},
},
2023-06-30 10:01:57 +02:00
themeConfig: {
editLink: {
pattern:
"https://github.com/ryan4yin/nixos-and-flakes-book/edit/main/docs/:path",
},
socialLinks: [
{
icon: "github",
link: "https://github.com/ryan4yin/nixos-and-flakes-book",
},
],
2023-06-30 10:01:57 +02:00
},
locales: {
root: themeConfigEnglish(),
zh: themeConfigChinese(),
},
});
function themeConfigEnglish() {
return {
label: "English",
lang: "en",
link: "/",
title: "NixOS & Flakes Book",
description: "An unofficial and opinionated book for beginners",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: "Home", link: "/" },
2023-07-28 09:55:48 +02:00
{ text: "Preface", link: "/preface.md" },
{ text: "Get Started", link: "/introduction/index.md" },
{ text: "Best Practices", link: "/best-practices/intro.md" },
],
2023-06-23 16:41:34 +02:00
sidebar: [
2023-07-28 09:55:48 +02:00
{
text: "Preface",
items: [{ text: "Preface", link: "/preface.md" }],
},
{
text: "Get Started",
items: [
{ text: "Introduction", link: "/introduction/index.md" },
{
text: "Advantages and Disadvantages",
link: "/introduction/advantages-and-disadvantages.md",
},
{
text: "Installation",
link: "/introduction/installation.md",
},
],
},
{
text: "The Nix Language",
items: [{ text: "Basics", link: "/the-nix-language/index.md" }],
},
{
text: "NixOS with Flakes",
items: [
{
text: "Get Started with NixOS",
link: "/nixos-with-flakes/get-started-with-nixos.md",
},
{
text: "Introduction to Flakes",
link: "/nixos-with-flakes/introduction-to-flakes.md",
},
{
text: "NixOS with Flakes Enabled",
link: "/nixos-with-flakes/nixos-with-flakes-enabled.md",
},
{
text: "Getting Started with Home Manager",
link: "/nixos-with-flakes/start-using-home-manager.md",
},
{
text: "Modularize the Configuration",
link: "/nixos-with-flakes/modularize-the-configuration.md",
},
{
text: "Updating the System",
link: "/nixos-with-flakes/update-the-system.md",
},
{
text: "Downgrading or Upgrading Packages",
link: "/nixos-with-flakes/downgrade-or-upgrade-packages.md",
},
{
text: "Other useful Tips",
link: "/nixos-with-flakes/other-useful-tips.md",
},
],
},
{
text: "Nixpkgs's Advanced Usage",
items: [
{ text: "Introduction", link: "/nixpkgs/intro.md" },
{ text: "callPackage", link: "/nixpkgs/callpackage.md" },
{ text: "Overridding", link: "/nixpkgs/overriding.md" },
{ text: "Overlays", link: "/nixpkgs/overlays.md" },
],
},
{
text: "Best Practices",
items: [
{ text: "Introduction", link: "/best-practices/intro.md" },
{
text: "Run downloaded binaries on NixOS",
link: "/best-practices/run-downloaded-binaries-on-nixos.md",
},
{
text: "Simplify NixOS-related Commands",
link: "/best-practices/simplify-nixos-related-commands.md",
},
{
text: "Custom NIX_PATH and Flake Registry",
link: "/best-practices/nix-path-and-flake-registry.md",
},
2023-08-03 05:31:14 +02:00
{
text: "Remote Deployment",
link: "/best-practices/remote-deployment.md",
},
{
2023-07-16 07:40:22 +02:00
text: "Debugging Derivations and Nix Expressions",
2023-07-16 07:38:36 +02:00
link: "/best-practices/debugging.md",
},
],
},
{
text: "Other Usage of Flakes",
items: [
{ text: "Introduction", link: "/other-usage-of-flakes/intro.md" },
{
text: "Flake Inputs",
link: "/other-usage-of-flakes/inputs.md",
},
{
text: "Flake Outputs",
link: "/other-usage-of-flakes/outputs.md",
},
{
text: "The New CLI",
link: "/other-usage-of-flakes/the-new-cli.md",
},
{
text: "Nix Options",
2023-07-07 20:47:48 +02:00
link: "/other-usage-of-flakes/options.md",
},
2023-07-16 07:27:57 +02:00
{
text: "Testing",
link: "/other-usage-of-flakes/testing.md",
},
],
},
{
text: "Dev Environments on NixOS",
items: [
2023-07-08 12:59:55 +02:00
{
text: "nix develop & pkgs.mkShell",
link: "/development/intro.md",
},
{
text: "Dev Environments",
link: "/development/dev-environments.md",
},
{
text: "Packaging 101",
link: "/development/packaging-101.md",
},
{
text: "Cross-platform Compilation",
link: "/development/cross-platform-compilation.md",
},
{
text: "Distribution Building",
link: "/development/distributed-building.md",
},
{
text: "Kernel Development",
link: "/development/kernel-development.md",
},
],
},
{
text: "Advanced Topics",
items: [
{ text: "Advanced Topics", link: "/advanced-topics/index.md" },
],
},
{
text: "Frequently Asked Questions",
items: [
{ text: "Frequently Asked Questions", link: "/faq/index.md" },
],
},
],
},
};
}
function themeConfigChinese() {
return {
label: "简体中文",
lang: "zh-CN",
link: "/zh/",
title: "NixOS 与 Flakes",
description: "一份非官方的新手指南",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: "首页", link: "/zh/" },
2023-07-28 09:55:48 +02:00
{ text: "前言", link: "/zh/preface.md" },
{ text: "开始使用", link: "/zh/introduction/index.md" },
{ text: "最佳实践", link: "/zh/best-practices/intro.md" },
],
2023-06-23 14:29:12 +02:00
sidebar: [
2023-07-28 09:55:48 +02:00
{
text: "前言",
items: [{ text: "前言", link: "/zh/preface.md" }],
},
{
text: "开始使用",
items: [
{ text: "简介", link: "/zh/introduction/index.md" },
{
text: "优缺点",
link: "/zh/introduction/advantages-and-disadvantages.md",
},
{
text: "安装",
link: "/zh/introduction/installation.md",
},
],
},
{
text: "Nix 语言",
items: [{ text: "快速入门", link: "/zh/the-nix-language/index.md" }],
},
{
text: "NixOS 与 Flakes",
items: [
{
text: "开始使用 NixOS",
link: "/zh/nixos-with-flakes/get-started-with-nixos.md",
},
{
text: "Flakes 简介",
link: "/zh/nixos-with-flakes/introduction-to-flakes.md",
},
{
text: "使用 Flakes 管理 NixOS",
link: "/zh/nixos-with-flakes/nixos-with-flakes-enabled.md",
},
{
text: "安装使用 Home Manager",
link: "/zh/nixos-with-flakes/start-using-home-manager.md",
},
{
text: "模块化系统配置",
link: "/zh/nixos-with-flakes/modularize-the-configuration.md",
},
{
text: "更新系统",
link: "/zh/nixos-with-flakes/update-the-system.md",
},
{
text: "降级或升级软件包",
link: "/zh/nixos-with-flakes/downgrade-or-upgrade-packages.md",
},
{
text: "其他杂七杂八的内容",
link: "/zh/nixos-with-flakes/other-useful-tips.md",
},
],
},
{
text: "Nixpkgs 高级用法",
items: [
{ text: "简介", link: "/zh/nixpkgs/intro.md" },
{ text: "callPackage", link: "/zh/nixpkgs/callpackage.md" },
{ text: "Overridding", link: "/zh/nixpkgs/overriding.md" },
{ text: "Overlays", link: "/zh/nixpkgs/overlays.md" },
],
},
{
text: "NixOS 最佳实践",
items: [
{ text: "简介", link: "/zh/best-practices/intro.md" },
{
text: "运行非 NixOS 的二进制文件",
link: "/zh/best-practices/run-downloaded-binaries-on-nixos.md",
},
{
text: "使用 Makefile 简化常用命令",
link: "/zh/best-practices/simplify-nixos-related-commands.md",
},
{
text: "自定义 NIX_PATH 与 Flake Registry",
link: "/zh/best-practices/nix-path-and-flake-registry.md",
},
2023-08-03 05:31:14 +02:00
{
text: "远程部署 Nix 配置",
link: "/zh/best-practices/remote-deployment.md",
},
{
2023-07-16 07:40:22 +02:00
text: "调试 Nix 软件包与 Nix 表达式",
2023-07-16 07:38:36 +02:00
link: "/zh/best-practices/debugging.md",
},
],
},
{
text: "Flakes 的其他玩法",
items: [
{ text: "简介", link: "/zh/other-usage-of-flakes/intro.md" },
{
text: "Flake Inputs",
link: "/zh/other-usage-of-flakes/inputs.md",
},
{
text: "Flake Outputs",
link: "/zh/other-usage-of-flakes/outputs.md",
},
{
text: "新一代 Nix 命令行工具的使用",
link: "/zh/other-usage-of-flakes/the-new-cli.md",
},
{
text: "Nix Options",
link: "/zh/other-usage-of-flakes/options.md",
},
2023-07-16 07:27:57 +02:00
{
text: "Testing",
link: "/zh/other-usage-of-flakes/testing.md",
},
],
},
{
text: "在 NixOS 上进行开发工作",
items: [
2023-07-08 12:59:55 +02:00
{
text: "nix develop 与 pkgs.mkShell",
link: "/zh/development/intro.md",
},
{
text: "各语言的开发环境",
link: "/zh/development/dev-environments.md",
},
{
text: "软件打包",
link: "/zh/development/packaging-101.md",
},
{
text: "跨平台编译",
link: "/zh/development/cross-platform-compilation.md",
},
{
text: "分布式构建",
link: "/zh/development/distributed-building.md",
},
{
text: "内核开发",
link: "/zh/development/kernel-development.md",
},
],
},
{
text: "其他进阶话题",
items: [
{ text: "其他进阶话题", link: "/zh/advanced-topics/index.md" },
],
},
{
text: "常见问题 FAQ",
items: [{ text: "常见问题 FAQ", link: "/zh/faq/index.md" }],
},
],
},
};
}
function getJSONLD(pageData: PageData) {
if (pageData.relativePath === "index.md") {
return `{
"@context":"http://schema.org",
"@type":"WebSite",
"url":"https:\/\/nixos-and-flakes.thiscute.world\/",
"inLanguage":"en",
"description":"An unofficial and opinionated book for beginners",
"name":"${pageData.title}"
}`;
} else if (pageData.relativePath === "zh/index.md") {
return `{
"@context":"http://schema.org",
"@type":"WebSite",
"url":"https:\/\/nixos-and-flakes.thiscute.world\/zh\/",
"inLanguage":"zh-CN",
"description":"一份非官方的新手指南",
"name":"${pageData.title}"
}`;
} else {
let lang = pageData.relativePath.startsWith("zh/") ? "zh-CN" : "en";
let url = `https:\/\/nixos-and-flakes.thiscute.world\/${pageData.relativePath
.replace(/\.md$/, "")
.replace(/\/index\$/, "/")}`;
return `{
"@context":"http://schema.org",
"@type":"TechArticle",
"headline":"${pageData.title} | NixOS & Flakes Book",
"inLanguage":"${lang}",
"mainEntityOfPage":{
"@type":"WebPage",
"@id":"${url}"
},
"keywords":"NixOS, Nix, Flakes, Linux, Tutorial",
"url":"${url}"
}`;
}
}