feat: init docs

.taskfiles/docs/Taskfile.yaml

@@ -0,0 +1,11 @@
+version: "3"
+
+vars:
+  DocsDir: "/docs"
+
+tasks:
+  serve:
+    desc: "Start the Docusaurus development server"
+    cmds:
+    - npm run start
+    dir: "{{.DocsDir}}"

.tool-versions

@@ -2,3 +2,4 @@ task 3.38.0
 trunk 1.22.3
 1password-cli 2.30.0
 age 1.2.0
+nodejs 22.5.1

.trunk/trunk.yaml

@@ -72,4 +72,4 @@ actions:
   - trunk-upgrade-available
 tools:
   enabled:
-  - action-validator@0.6.0
+  - action-validator@0.6.0

.vscode/settings.json

@@ -222,4 +222,4 @@
     "**/.trunk/*tmp/": true,
     "**/.trunk/*tools/": true,
   },
-}
+}

Taskfile.yaml

@@ -16,6 +16,9 @@ includes:
   ansible:
     taskfile: ".taskfiles/ansible/Taskfile.yaml"
     aliases: [a]
+  docusaurus:
+    taskfile: ".taskfiles/docs/Taskfile.yaml"
+    aliases: [d, docs]
 
 tasks:
   default:

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/blog/authors.yml

@@ -0,0 +1,8 @@
+kilian:
+  name: Kilian Tyler
+  title: Dotfiles Enthusiast
+  url: https://github.com/kiliantyler
+  image_url: https://github.com/kiliantyler.png
+  page: true
+  socials:
+    github: kiliantyler

docs/blog/tags.yml

@@ -0,0 +1,4 @@
+hello:
+  label: Hello
+  permalink: /hello
+  description: Hello tag description

docs/docusaurus.config.ts

@@ -0,0 +1,112 @@
+import type * as Preset from '@docusaurus/preset-classic';
+import type { Config } from '@docusaurus/types';
+import { themes as prismThemes } from 'prism-react-renderer';
+
+const config: Config = {
+  title: 'Dotfiles',
+  tagline: 'One-stop shop for my dotfiles',
+  favicon: 'img/favicon.ico',
+
+  url: 'https://dotfiles.kiliantyler.com',
+  baseUrl: '/',
+  organizationName: 'kiliantyler',
+  projectName: 'dotfiles',
+  deploymentBranch: 'gh-pages',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      {
+        docs: {
+          routeBasePath: '/wiki',
+          path: './wiki',
+          sidebarPath: './sidebars.ts',
+        },
+        blog: false, // Disable for now
+        // blog: {
+        //   showReadingTime: true,
+        //   feedOptions: {
+        //     type: ['rss', 'atom'],
+        //     xslt: true,
+        //   },
+        //   // Please change this to your repo.
+        //   // Remove this to remove the "edit this page" links.
+        //   editUrl:
+        //     'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+        //   // Useful options to enforce blogging best practices
+        //   onInlineTags: 'warn',
+        //   onInlineAuthors: 'warn',
+        //   onUntruncatedBlogPosts: 'warn',
+        // },
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      } satisfies Preset.Options,
+    ],
+  ],
+
+  themeConfig: {
+    image: 'img/social-card.png',
+    navbar: {
+      title: 'Dotfiles',
+      logo: {
+        alt: 'Dotfiles Logo',
+        src: 'img/logo.svg',
+      },
+      items: [
+        {
+          type: 'docSidebar',
+          sidebarId: 'tutorialSidebar',
+          position: 'left',
+          label: 'Wiki',
+        },
+        // {to: '/blog', label: 'Blog', position: 'left'}, // Disable for now
+        {
+          href: 'https://github.com/kiliantyler/dotfiles',
+          label: 'GitHub',
+          position: 'right',
+        },
+      ],
+    },
+    footer: {
+      style: 'dark',
+      links: [
+        {
+          title: 'Wiki',
+          items: [
+            {
+              label: 'Dotfiles',
+              to: '/wiki/intro',
+            },
+          ],
+        },
+        {
+          title: 'More',
+          items: [
+            // {
+            //   label: 'Blog',
+            //   to: '/blog',
+            // },
+            {
+              label: 'GitHub',
+              href: 'https://github.com/kiliantyler/dotfiles',
+            },
+          ],
+        },
+      ],
+      copyright: `Copyright © ${new Date().getFullYear()} Kilian Tyler. Built with Docusaurus.`,
+    },
+    prism: {
+      theme: prismThemes.github,
+      darkTheme: prismThemes.dracula,
+    },
+  } satisfies Preset.ThemeConfig,
+};
+
+export default config;