helix-editor · nik-rev · Nov 16, 2024 · Nov 16, 2024 · Nov 16, 2024 · Nov 16, 2024
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,34 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [master]
+  # To run this workflow manually from the Actions tab on GitHub.
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v4
+      - name: Install, build, and upload your site
+        uses: withastro/action@v3
+        with:
+          path: website
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/website/.gitignore b/website/.gitignore
@@ -0,0 +1,23 @@
+.cache
+
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
diff --git a/website/.prettierrc.mjs b/website/.prettierrc.mjs
@@ -0,0 +1,12 @@
+/** @type {import("prettier").Config} */
+export default {
+  plugins: ["prettier-plugin-astro"],
+  overrides: [
+    {
+      files: "*.astro",
+      options: {
+        parser: "astro",
+      },
+    },
+  ],
+};
diff --git a/website/README.md b/website/README.md
@@ -0,0 +1,9 @@
+# Helix Docs
+
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+
+The Helix documentation.
+
+[Contributing instructions](https://helix-editor.vercel.app/contributing/this-site).
+
+The new website is available at [helix-editor.vercel.app](https://helix-editor.vercel.app).
diff --git a/website/astro.config.mjs b/website/astro.config.mjs
@@ -0,0 +1,150 @@
+// @ts-check
+import { defineConfig } from "astro/config";
+import starlight from "@astrojs/starlight";
+import starlightLinksValidator from "starlight-links-validator";
+import starlightBlog from "starlight-blog";
+import starlightImageZoom from "starlight-image-zoom";
+import { rehypeHeadingIds } from "@astrojs/markdown-remark";
+import rehypeAutolinkHeadings from "rehype-autolink-headings";
+import rehypeExternalLinks from "rehype-external-links";
+
+import sitemap from "@astrojs/sitemap";
+
+// https://astro.build/config
+export default defineConfig({
+  site: "https://helix-editor.vercel.app",
+  vite: {
+    optimizeDeps: { include: ["asciinema-player"] },
+  },
+  markdown: {
+    rehypePlugins: [
+      rehypeHeadingIds,
+
+      [
+        rehypeExternalLinks,
+        {
+          content: {
+            type: "text",
+            value: " ↗",
+          },
+          properties: {
+            target: "_blank",
+          },
+          rel: ["noopener"],
+        },
+      ],
+      [rehypeAutolinkHeadings, { behavior: "wrap" }],
+    ],
+  },
+  integrations: [
+    starlight({
+      tableOfContents: {
+        maxHeadingLevel: 5,
+      },
+      head: [
+        {
+          tag: "link",
+          attrs: {
+            rel: "sitemap",
+            href: "/sitemap-index.xml",
+          },
+        },
+        {
+          tag: "script",
+          attrs: {
+            src: "https://static.cloudflareinsights.com/beacon.min.js",
+            "data-cf-beacon": '{"token": "1c63f959be334c96913d5c16499a3887"}',
+            defer: true,
+          },
+        },
+      ],
+      plugins: [
+        starlightImageZoom(),
+        starlightLinksValidator(),
+        starlightBlog({ title: "News", prefix: "news" }),
+      ],
+      title: "Helix",
+      logo: {
+        src: "./public/favicon.svg",
+      },
+      social: {
+        github: "https://github.com/helix-editor/helix",
+        matrix: "https://matrix.to/#/#helix-community:matrix.org",
+      },
+      components: {
+        ThemeProvider: "./src/components/ThemeProvider.astro",
+        ThemeSelect: "./src/components/ThemeSelect.astro",
+        Head: "./src/components/Head.astro",
+      },
+      editLink: {
+        baseUrl:
+          "https://github.com/NikitaRevenco/helix/tree/new-website/website",
+      },
+      sidebar: [
+        {
+          label: "Start Here",
+          items: ["start-here/installation", "start-here/basics"],
+        },
+        {
+          label: "Usage",
+          items: [
+            "usage/multiple-cursors",
+            "usage/macros",
+            "usage/text-objects",
+            "usage/surround",
+            "usage/language-support",
+            "usage/buffers",
+            "usage/pickers",
+          ],
+        },
+        {
+          label: "Reference",
+          items: [
+            "reference/keymap",
+            "reference/typed-commands",
+            "reference/list-of-themes",
+            "reference/custom-themes",
+            "reference/registers",
+            "reference/language-servers",
+            "reference/formatters",
+            "reference/debuggers",
+          ],
+        },
+        {
+          label: "Configuration",
+          items: [
+            "configuration/editor",
+            "configuration/languages",
+            "configuration/remapping",
+          ],
+        },
+        {
+          label: "Help",
+          items: [
+            "help/recipes",
+            "help/faq",
+            "help/troubleshooting",
+            "help/terminal-support",
+            "help/language-defaults",
+            "help/refactor-examples",
+          ],
+        },
+        {
+          label: "Contributing to Helix",
+          items: [
+            "contributing/vision",
+            "contributing/this-site",
+            "contributing/releases",
+            "contributing/architecture",
+            "contributing/languages",
+            "contributing/textobject-queries",
+            "contributing/indent-queries",
+            "contributing/injection-queries",
+          ],
+        },
+      ],
+      customCss: ["./src/globals.css"],
+    }),
+    sitemap(),
+  ],
+});
diff --git a/website/favicon.svg b/website/favicon.svg
diff --git a/website/package.json b/website/package.json
@@ -0,0 +1,39 @@
+{
+  "name": "helix-docs",
+  "type": "module",
+  "packageManager": "pnpm@latest",
+  "version": "1.0.0",
+  "scripts": {
+    "generate:termshot-index-files": "node scripts/termshots.js",
+    "generate:list-of-themes": "node scripts/list-of-themes.js",
+    "termshots": "pnpm generate:list-of-themes && pnpm generate:termshot-index-files",
+    "predev": "pnpm termshots",
+    "prebuild": "pnpm termshots",
+    "prepreview": "pnpm termshots",
+    "dev": "astro dev",
+    "build": "astro check && astro build",
+    "preview": "astro preview",
+    "astro": "astro"
+  },
+  "dependencies": {
+    "@astrojs/check": "^0.9.4",
+    "@astrojs/markdown-remark": "^5.3.0",
+    "@astrojs/sitemap": "^3.2.1",
+    "@astrojs/starlight": "^0.29.2",
+    "asciinema-player": "^3.8.1",
+    "astro": "^4.16.10",
+    "astro-og-canvas": "^0.5.4",
+    "canvaskit-wasm": "^0.39.1",
+    "rehype-autolink-headings": "^7.1.0",
+    "rehype-external-links": "^3.0.0",
+    "sharp": "^0.32.5",
+    "starlight-blog": "^0.15.0",
+    "starlight-contributor-list": "^0.1.0",
+    "starlight-image-zoom": "^0.9.0",
+    "starlight-links-validator": "^0.13.2",
+    "typescript": "^5.6.3"
+  },
+  "devDependencies": {
+    "@iarna/toml": "^2.2.5"
+  }
+}