docs: format with prettier (#2420)

loculus-project · Aug 13, 2024 · 849fec7 · 849fec7
1 parent 69c44ff
commit 849fec7
Show file tree

Hide file tree

Showing 17 changed files with 12,059 additions and 11,951 deletions.
diff --git a/docs/.prettierrc b/docs/.prettierrc
@@ -0,0 +1,18 @@
+{
+  "printWidth": 120,
+  "tabWidth": 4,
+  "trailingComma": "all",
+  "semi": true,
+  "jsxSingleQuote": true,
+  "singleQuote": true,
+  "quoteProps": "consistent",
+  "plugins": ["prettier-plugin-astro"],
+  "overrides": [
+    {
+      "files": "*.astro",
+      "options": {
+        "parser": "astro"
+      }
+    }
+  ]
+}
diff --git a/docs/.vite/deps/_metadata.json b/docs/.vite/deps/_metadata.json
@@ -1,8 +1,8 @@
 {
-  "hash": "c1e8de51",
-  "configHash": "0c82321a",
-  "lockfileHash": "25f1fc72",
-  "browserHash": "cf2b5ff5",
-  "optimized": {},
-  "chunks": {}
+    "hash": "c1e8de51",
+    "configHash": "0c82321a",
+    "lockfileHash": "25f1fc72",
+    "browserHash": "cf2b5ff5",
+    "optimized": {},
+    "chunks": {}
 }
diff --git a/docs/.vite/deps/package.json b/docs/.vite/deps/package.json
@@ -1,3 +1,3 @@
 {
-  "type": "module"
+    "type": "module"
 }
diff --git a/docs/.vscode/extensions.json b/docs/.vscode/extensions.json
@@ -1,4 +1,4 @@
 {
-  "recommendations": ["astro-build.astro-vscode"],
-  "unwantedRecommendations": []
+    "recommendations": ["astro-build.astro-vscode"],
+    "unwantedRecommendations": []
 }
diff --git a/docs/.vscode/launch.json b/docs/.vscode/launch.json
@@ -1,11 +1,11 @@
 {
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "command": "./node_modules/.bin/astro dev",
-      "name": "Development server",
-      "request": "launch",
-      "type": "node-terminal"
-    }
-  ]
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "command": "./node_modules/.bin/astro dev",
+            "name": "Development server",
+            "request": "launch",
+            "type": "node-terminal"
+        }
+    ]
 }
diff --git a/docs/README.md b/docs/README.md
@@ -39,6 +39,6 @@ All commands are run from the root of the project, from a terminal:
 | `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
 | `npm run astro -- --help` | Get help using the Astro CLI                     |
 
-##  More information.
+## More information.
 
 Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build).
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -1,44 +1,42 @@
-import { defineConfig } from "astro/config";
-import starlight from "@astrojs/starlight";
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
 
 // https://astro.build/config
 export default defineConfig({
-  base: "/loculus/",
-  integrations: [
-    starlight({
-      title: "Loculus",
-      editLink: {
-        baseUrl: "https://github.com/loculus-project/loculus/edit/main/docs/",
-      },
-      customCss: [
-        "./src/styles/custom.css",
-      ],
-      social: {
-        github: "https://github.com/loculus-project/loculus",
-      },
-      sidebar: [
-        {
-          label: "Introduction",
-          items: [
-            { label: "What is Loculus?", link: "/introduction/what-is-loculus/" },
-            { label: "Current state and roadmap", link: "/introduction/current-state-and-roadmap/" },
-            { label: "Glossary", link: "/introduction/glossary/" },
-            { label: "System overview", link: "/introduction/system-overview/" },
-          ],
-        },
-        {
-          label: "For administrators",
-          items: [
-            { label: "Getting started", link: "/for-administrators/getting-started/" },
-            { label: "Setup with Kubernetes", link: "/for-administrators/setup-with-kubernetes/" },
-            { label: "User administration", link: "/for-administrators/user-administration/" },
-          ],
-        },
-        {
-          label: "Reference",
-          autogenerate: { directory: "reference" },
-        },
-      ],
-    }),
-  ],
+    base: '/loculus/',
+    integrations: [
+        starlight({
+            title: 'Loculus',
+            editLink: {
+                baseUrl: 'https://github.com/loculus-project/loculus/edit/main/docs/',
+            },
+            customCss: ['./src/styles/custom.css'],
+            social: {
+                github: 'https://github.com/loculus-project/loculus',
+            },
+            sidebar: [
+                {
+                    label: 'Introduction',
+                    items: [
+                        { label: 'What is Loculus?', link: '/introduction/what-is-loculus/' },
+                        { label: 'Current state and roadmap', link: '/introduction/current-state-and-roadmap/' },
+                        { label: 'Glossary', link: '/introduction/glossary/' },
+                        { label: 'System overview', link: '/introduction/system-overview/' },
+                    ],
+                },
+                {
+                    label: 'For administrators',
+                    items: [
+                        { label: 'Getting started', link: '/for-administrators/getting-started/' },
+                        { label: 'Setup with Kubernetes', link: '/for-administrators/setup-with-kubernetes/' },
+                        { label: 'User administration', link: '/for-administrators/user-administration/' },
+                    ],
+                },
+                {
+                    label: 'Reference',
+                    autogenerate: { directory: 'reference' },
+                },
+            ],
+        }),
+    ],
 });