Merge pull request #345 from GenSpectrum/lapis2-docs

Lapis v2 docs

Author: chaoran-chen

lapis2-docs/.env.example

@@ -0,0 +1,3 @@
+# Create a .env file with this input might NOT work. You might need to properly set CONFIG_FILE as an
+# environment variable.
+CONFIG_FILE=../lapis2/src/test/resources/config/testDatabaseConfig.yaml

lapis2-docs/.gitignore

@@ -0,0 +1,21 @@
+# 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

lapis2-docs/.prettierrc

@@ -0,0 +1,19 @@
+{
+  "printWidth": 120,
+  "tabWidth": 4,
+  "trailingComma": "all",
+  "semi": true,
+  "jsxSingleQuote": true,
+  "singleQuote": true,
+  "quoteProps": "consistent",
+  "proseWrap": "always",
+  "plugins": ["prettier-plugin-astro"],
+  "overrides": [
+    {
+      "files": "*.astro",
+      "options": {
+        "parser": "astro"
+      }
+    }
+  ]
+}

lapis2-docs/README.md

@@ -0,0 +1,53 @@
+# Starlight Starter Kit: Basics
+
+```
+npm create astro@latest -- --template starlight
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+## 🚀 Project Structure
+
+Inside of your Astro + Starlight project, you'll see the following folders and files:
+
+```
+.
+├── public/
+├── src/
+│   ├── assets/
+│   ├── content/
+│   │   ├── docs/
+│   │   └── config.ts
+│   └── env.d.ts
+├── astro.config.mjs
+├── package.json
+└── tsconfig.json
+```
+
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on
+its file name.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+Static assets, like favicons, can be placed in the `public/` directory.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command                   | Action                                           |
+| :------------------------ | :----------------------------------------------- |
+| `npm install`             | Installs dependencies                            |
+| `npm run dev`             | Starts local dev server at `localhost:3000`      |
+| `npm run build`           | Build your production site to `./dist/`          |
+| `npm run preview`         | Preview your build locally, before deploying     |
+| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI                     |
+
+## 👀 Want to learn more?
+
+Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build),
+or jump into the [Astro Discord server](https://astro.build/chat).

lapis2-docs/astro.config.mjs

@@ -0,0 +1,110 @@
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+import react from '@astrojs/react';
+import { hasFeature } from './src/config.ts';
+
+import tailwind from '@astrojs/tailwind';
+
+// https://astro.build/config
+export default defineConfig({
+    integrations: [
+        starlight({
+            title: 'LAPIS',
+            social: {
+                github: 'https://github.com/GenSpectrum/LAPIS',
+            },
+            customCss: ['./src/styles/custom.css'],
+            editLink: {
+                baseUrl: 'https://github.com/GenSpectrum/LAPIS/tree/main/lapis2-docs/',
+            },
+            sidebar: [
+                {
+                    label: 'Getting started',
+                    items: [
+                        {
+                            label: 'Introduction',
+                            link: '/getting-started/introduction',
+                        },
+                        {
+                            label: 'Generate your request',
+                            link: '/getting-started/generate-your-request',
+                        },
+                    ],
+                },
+                {
+                    label: 'References',
+                    items: [
+                        {
+                            label: 'Endpoints',
+                            link: '/references/endpoints/',
+                        },
+                        {
+                            label: 'Fields',
+                            link: '/references/fields/',
+                        },
+                        {
+                            label: 'Filters',
+                            link: '/references/filters/',
+                        },
+                        {
+                            label: 'Open API / Swagger',
+                            link: '/references/open-api-definition/',
+                        },
+                    ],
+                },
+                {
+                    label: 'Concepts',
+                    items: filterAvailableConcepts([
+                        {
+                            label: 'Data versions',
+                            link: '/concepts/data-versions/',
+                        },
+                        {
+                            label: 'Mutation filters',
+                            link: '/concepts/mutation-filters/',
+                        },
+                        {
+                            label: 'Pango lineage query',
+                            link: '/concepts/pango-lineage-query/',
+                            onlyIfFeature: 'sarsCoV2VariantQuery',
+                        },
+                        {
+                            label: 'Request methods: GET and POST',
+                            link: '/concepts/request-methods/',
+                        },
+                        {
+                            label: 'Response format',
+                            link: '/concepts/response-format/',
+                        },
+                        {
+                            label: 'Variant query',
+                            link: '/concepts/variant-query/',
+                            onlyIfFeature: 'sarsCoV2VariantQuery',
+                        },
+                    ]),
+                },
+            ],
+        }),
+        react(),
+        tailwind(),
+    ],
+    // Process images with sharp: https://docs.astro.build/en/guides/assets/#using-sharp
+    image: {
+        service: {
+            entrypoint: 'astro/assets/services/sharp',
+        },
+    },
+});
+
+/**
+ * TODO Not sure if this is actually a good solution. The filtering now happens at compile time but ideally, it happens
+ *   at runtime (so that the user/maintainer does not need to re-compile for their own config).
+ */
+function filterAvailableConcepts(pages) {
+    return pages
+        .filter((p) => !p.onlyIfFeature || hasFeature(p.onlyIfFeature))
+        .map(({ label, link }) => ({
+            label,
+            link,
+        }));
+}