docs: setup vitepress project correctly

Author: d-biehl

.devcontainer/devcontainer.json

@@ -81,9 +81,6 @@
         "evenBetterToml.schema.associations": {
           "^(.*(/|\\\\)\\.?robot\\.toml|\\.?robot\\.toml)$": "http://localhost:8000/etc/robot.toml.json"
         },
-        "yaml.schemas": {
-          "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
-        },
         "mypy-type-checker.importStrategy": "fromEnvironment",
         "debugpy.debugJustMyCode": false,
         "black-formatter.importStrategy": "fromEnvironment",

.vscode/tasks.json

@@ -20,13 +20,6 @@
 			"type": "shell",
 			"command": "hatch run build:bump",
 			"problemMatcher": []
-		},
-		{
-			"label": "robotcode: mkdocs serve",
-			"type": "shell",
-			"command": "hatch run pages:mkdocs serve",
-			"problemMatcher": []
 		}
-
 	]
 }

.vscodeignore

@@ -46,10 +46,8 @@ playground
 coverage.xml
 .python-version
 
-# mkdocs
+# docs
 docs
-overrides
-site
 
 # others
 scripts

docs/.vitepress/config.mts

@@ -1,11 +1,14 @@
 import { defineConfig } from "vitepress";
 import { generateSidebar } from "vitepress-sidebar";
+import taskLists from "markdown-it-task-lists";
+import { tabsMarkdownPlugin } from "vitepress-plugin-tabs";
 import robotframework from "../../syntaxes/robotframework.tmLanguage.json";
 import { readFileSync } from "fs";
-
-const python_svg = readFileSync("docs/images/python.svg", "utf-8");
-const vscode_svg = readFileSync("docs/images/vscode.svg", "utf-8");
-const opencollective_svg = readFileSync("docs/images/opencollective.svg", "utf-8");
+import pkg from "../../package.json";
+//import python_svg from "../images/python.svg?raw";
+const python_svg = readFileSync("images/python.svg", "utf-8");
+const vscode_svg = readFileSync("images/vscode.svg", "utf-8");
+const opencollective_svg = readFileSync("images/opencollective.svg", "utf-8");
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -15,7 +18,20 @@ export default defineConfig({
   lastUpdated: true,
   cleanUrls: true,
   metaChunk: true,
-
+  sitemap: {
+    hostname: "https://robotcode.io",
+  },
+  head: [
+    ["link", { rel: "icon", type: "image/svg+xml", href: "/robotcode-logo.svg" }],
+    ["link", { rel: "icon", type: "image/png", href: "/robotcode-logo-mini.png" }],
+    ["meta", { name: "theme-color", content: "#5f67ee" }],
+    ["meta", { property: "og:type", content: "website" }],
+    ["meta", { property: "og:locale", content: "en" }],
+    ["meta", { property: "og:title", content: "RobotCode | Robot Framework for Visual Studio Code and more" }],
+    ["meta", { property: "og:site_name", content: "RobotCode" }],
+    ["meta", { property: "og:image", content: "https://robotcode.io/robotcode-logo.jpg" }],
+    ["meta", { property: "og:url", content: "https://robotcode.io/" }],
+  ],
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     logo: { src: "/robotcode-logo.svg", alt: "RobotCode Logo" },
@@ -33,6 +49,19 @@ export default defineConfig({
       { text: "Documentation", link: "/01_about" },
       { text: "Contribute", link: "https://github.com/robotcodedev" },
       { text: "Q&A", link: "https://github.com/robotcodedev/robotcode/discussions/categories/q-a" },
+      {
+        text: pkg.version,
+        items: [
+          {
+            text: "Changelog",
+            link: "https://github.com/robotcodedev/robotcode/blob/main/CHANGELOG.md",
+          },
+          {
+            text: "Contributing",
+            link: "https://github.com/robotcodedev/robotcode/blob/main/CONTRIBUTING.md",
+          },
+        ],
+      },
     ],
     search: {
       provider: "local",
@@ -50,7 +79,7 @@ export default defineConfig({
     //   }
     // ],
     sidebar: generateSidebar({
-      documentRootPath: "docs",
+      documentRootPath: ".",
       collapsed: true,
       useTitleFromFileHeading: true,
       useTitleFromFrontmatter: true,
@@ -65,8 +94,15 @@ export default defineConfig({
     ],
   },
   markdown: {
+    config(md: any) {
+      md.use(taskLists);
+      md.use(tabsMarkdownPlugin);
+    },
+    attrs: {
+      disable: false,
+    },
     image: {
-      lazyLoading: true
+      lazyLoading: true,
     },
     lineNumbers: true,
     theme: { light: "material-theme-lighter", dark: "material-theme-darker" },

docs/.vitepress/theme/index.ts

@@ -1,17 +1,19 @@
 // https://vitepress.dev/guide/custom-theme
-import { h } from 'vue'
-import type { Theme } from 'vitepress'
-import DefaultTheme from 'vitepress/theme'
-import './style.css'
+import { h } from "vue";
+import type { Theme } from "vitepress";
+import DefaultTheme from "vitepress/theme";
+import { enhanceAppWithTabs } from "vitepress-plugin-tabs/client";
+import "./style.css";
 
 export default {
   extends: DefaultTheme,
   Layout: () => {
     return h(DefaultTheme.Layout, null, {
       // https://vitepress.dev/guide/extending-default-theme#layout-slots
-    })
+    });
   },
   enhanceApp({ app, router, siteData }) {
     // ...
-  }
-} satisfies Theme
+    enhanceAppWithTabs(app);
+  },
+} satisfies Theme;

docs/.vitepress/theme/style.css

@@ -43,7 +43,7 @@
  *   in custom container, badges, etc.
  * -------------------------------------------------------------------------- */
 
- :root {
+:root {
   --vp-c-default-1: var(--vp-c-gray-1);
   --vp-c-default-2: var(--vp-c-gray-2);
   --vp-c-default-3: var(--vp-c-gray-3);
@@ -92,17 +92,13 @@
 
 :root {
   --vp-home-hero-name-color: transparent;
-  --vp-home-hero-name-background: -webkit-linear-gradient(
-    90deg,
-    #234a34 10%,
-    #e9e9e2
-  );
-
-  --vp-home-hero-image-background-image: linear-gradient(
-    -45deg,
-    #242f29 50%,
-    #2e4e31 50%
-  );
+  --vp-home-hero-name-background: -webkit-linear-gradient(90deg,
+      #234a34 10%,
+      #e9e9e2);
+
+  --vp-home-hero-image-background-image: linear-gradient(-45deg,
+      #242f29 50%,
+      #2e4e31 50%);
   --vp-home-hero-image-filter: blur(44px);
 }
 
@@ -141,7 +137,7 @@
  * Typography
  * -------------------------------------------------------------------------- */
 
- :root {
+:root {
   --vp-font-family-base: 'Inter', ui-sans-serif, system-ui, sans-serif,
     'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji';
   --vp-font-family-mono: ui-monospace, 'Menlo', 'Monaco', 'Consolas',
@@ -158,4 +154,8 @@
 
 .VPHero .name {
   font-family: "Courier New", system-ui;
+}
+
+img[src*="shields.io"] {
+  display: inline;
 }

docs/99_features.md

@@ -6,14 +6,29 @@
 *** Test Cases ***
 Test
     Log    Hello, world!
-
+    IF  $a + "asdasd" + 1
+    END
 ```
 
 ## some more tests
 
-```robot[1-3]
+```robot
 *** Test Cases ***
 Test
     Log    Hello, world!
 
-```
+```
+
+:::tabs
+== tab a
+a content
+== tab b
+b content
+:::
+
+:::tabs
+== tab a
+a content 2
+== tab b
+b content 2
+:::

docs/index.md

@@ -40,10 +40,14 @@ features:
   - title: Feature C
     details: Lorem ipsum dolor sit amet, consectetur adipiscing elit---
 ---
+
+
+
+
 [![Visual Studio Marketplace](https://img.shields.io/visual-studio-marketplace/v/d-biehl.robotcode?style=flat&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
 [![Installs](https://img.shields.io/visual-studio-marketplace/i/d-biehl.robotcode?style=flat)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/robotcodedev/robotcode/build-test-package-publish.yml?branch=main&style=flat&logo=github)](https://github.com/robotcodedev/robotcode/actions?query=workflow:build_test_package_publish)
-[![License](https://img.shields.io/github/license/robotcodedev/robotcode?style=flat&logo=apache)](https://github.com/robotcodedev/robotcode/blob/master/LICENSE)
 [![PyPI - Version](https://img.shields.io/pypi/v/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/robotcode.svg?style=flat&label=downloads)](https://pypi.org/project/robotcode/)
+{align="center"}

docs/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "docs",
+    "private": true,
+    "type": "module",
+    "scripts": {
+        "dev": "vitepress dev",
+        "build": "vitepress build",
+        "preview": "vitepress preview"
+    },
+    "devDependencies": {
+        "markdown-it-mathjax3": "^4.3.2",
+        "markdown-it-task-lists": "^2.1.1",
+        "typescript": "^5.4.5",
+        "typescript-eslint": "^7.9.0",
+        "vitepress": "^1.2.0",
+        "vitepress-plugin-tabs": "^0.5.0",
+        "vitepress-sidebar": "^1.23.2"
+    }
+}