initial

wkillerud · wkillerud · commit 9b2bfde98d28 · 2024-02-13T21:02:15.000+01:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,42 @@
+# Starlight Starter Kit: Basics
+
+## 🚀 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:4321`      |
+| `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).
diff --git a/README.md b/README.md
@@ -1,54 +1,3 @@
-# Starlight Starter Kit: Basics
+# MetricsJS Documentation
 
-[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
-
-```
-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)
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
-
-> 🧑‍🚀 **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:4321`      |
-| `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).
+Link in sidebar 💁
diff --git a/astro.config.mjs b/astro.config.mjs
@@ -5,18 +5,24 @@ import starlight from '@astrojs/starlight';
 export default defineConfig({
 	integrations: [
 		starlight({
-			title: 'My Docs',
+			title: 'MetricsJS',
+			logo: { src: './src/assets/metrics-js-logo.svg' },
+			customCss: ['./src/styles/theme.css'],
 			social: {
-				github: 'https://github.com/withastro/starlight',
+				github: 'https://github.com/metrics-js/documentation',
 			},
 			sidebar: [
 				{
-					label: 'Guides',
+					label: 'Introduction',
 					items: [
-						// Each item here is one entry in the navigation menu.
-						{ label: 'Example Guide', link: '/guides/example/' },
+						{ label: 'Getting started', link: '/introduction/getting-started/' },
+						{ label: 'Why MetricsJS', link: '/introduction/why-metrics-js/' },
 					],
 				},
+				{
+					label: 'Guides',
+					autogenerate: { directory: 'guides' },
+				},
 				{
 					label: 'Reference',
 					autogenerate: { directory: 'reference' },
diff --git a/src/assets/houston.webp b/src/assets/houston.webp
diff --git a/src/assets/metrics-js-logo.svg b/src/assets/metrics-js-logo.svg
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg version="1.1" viewBox="0 0 630 630" xmlns="http://www.w3.org/2000/svg" xmlns:cc="http://creativecommons.org/ns#" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+ <g>
+  <rect id="background" width="630" height="630" style="fill:#f7df1e"/>
+  <g transform="matrix(.33827 0 0 .33827 265.77 245.58)">
+   <path d="m144.5 990h118.9v-253.7h-118.9zm198.2 0h118.9v-372.6h-118.9zm221.9 0h118.9v-467.8h-118.9zm214.1 0h118.9v-602.5h-118.9zm105.7-713.5 46.9-266.5-266.5 59.8 82.2 77.4-231.7 240.9-114.7-103-331.9 340.4 48.5 47.2-.1-.1 286.6-293.9 115.1 103.2 277.5-288.4z"/>
+  </g>
+ </g>
+</svg>
diff --git a/src/content/docs/guides/collecting-metrics-prometheus.md b/src/content/docs/guides/collecting-metrics-prometheus.md
@@ -0,0 +1,3 @@
+---
+title: Collecting to Prometheus
+---
diff --git a/src/content/docs/guides/example.md b/src/content/docs/guides/example.md
diff --git a/src/content/docs/guides/multiple-levels.md b/src/content/docs/guides/multiple-levels.md
@@ -0,0 +1,3 @@
+---
+title: Passing through multiple modules
+---
diff --git a/src/content/docs/index.md b/src/content/docs/index.md
@@ -0,0 +1,5 @@
+---
+title: Welcome to MetricsJS
+description: Streaming metrics for Node.js
+---
+
diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx
diff --git a/src/content/docs/introduction/getting-started.md b/src/content/docs/introduction/getting-started.md
@@ -0,0 +1,3 @@
+---
+title: Getting started
+---
diff --git a/src/content/docs/introduction/why-metrics-js.md b/src/content/docs/introduction/why-metrics-js.md
@@ -0,0 +1,3 @@
+---
+title: Why MetricsJS?
+---
diff --git a/src/content/docs/reference/client.md b/src/content/docs/reference/client.md
@@ -0,0 +1,5 @@
+---
+title: '@metrics/client'
+---
+
+asdfasd
diff --git a/src/content/docs/reference/collectors.md b/src/content/docs/reference/collectors.md
@@ -0,0 +1,5 @@
+---
+title: '@metrics/collectors'
+---
+
+asdfasd
diff --git a/src/content/docs/reference/daemon.md b/src/content/docs/reference/daemon.md
@@ -0,0 +1,5 @@
+---
+title: '@metrics/daemon'
+---
+
+asdfasd
diff --git a/src/content/docs/reference/emitter.md b/src/content/docs/reference/emitter.md
@@ -0,0 +1,5 @@
+---
+title: '@metrics/emitter'
+---
+
+asdfasd
diff --git a/src/content/docs/reference/example.md b/src/content/docs/reference/example.md
diff --git a/src/content/docs/reference/guard.md b/src/content/docs/reference/guard.md
@@ -0,0 +1,5 @@
+---
+title: '@metrics/guard'
+---
+
+asdfasd
diff --git a/src/content/docs/reference/metric.md b/src/content/docs/reference/metric.md
@@ -0,0 +1,5 @@
+---
+title: '@metrics/metric'
+---
+
+asdfasd
diff --git a/src/content/docs/reference/process.md b/src/content/docs/reference/process.md
@@ -0,0 +1,5 @@
+---
+title: '@metrics/process'
+---
+
+asdfasd
diff --git a/src/content/docs/reference/prometheus-consumer.md b/src/content/docs/reference/prometheus-consumer.md
@@ -0,0 +1,5 @@
+---
+title: '@metrics/prometheus-consumer'
+---
+
+asdfasd
diff --git a/src/styles/theme.css b/src/styles/theme.css
@@ -0,0 +1,29 @@
+/* Dark mode colors. */
+:root {
+	--sl-color-accent-low: #272500;
+	--sl-color-accent: #726d00;
+	--sl-color-accent-high: #cdcc9b;
+	--sl-color-white: #ffffff;
+	--sl-color-gray-1: #eceef2;
+	--sl-color-gray-2: #c0c2c7;
+	--sl-color-gray-3: #888b96;
+	--sl-color-gray-4: #545861;
+	--sl-color-gray-5: #353841;
+	--sl-color-gray-6: #24272f;
+	--sl-color-black: #17181c;
+}
+/* Light mode colors. */
+:root[data-theme='light'] {
+	--sl-color-accent-low: #dadab5;
+	--sl-color-accent: #746f00;
+	--sl-color-accent-high: #373400;
+	--sl-color-white: #17181c;
+	--sl-color-gray-1: #24272f;
+	--sl-color-gray-2: #353841;
+	--sl-color-gray-3: #545861;
+	--sl-color-gray-4: #888b96;
+	--sl-color-gray-5: #c0c2c7;
+	--sl-color-gray-6: #eceef2;
+	--sl-color-gray-7: #f5f6f8;
+	--sl-color-black: #ffffff;
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+---`
	`2`	`+title: Collecting to Prometheus`
	`3`	`+---`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+---`
	`2`	`+title: Passing through multiple modules`
	`3`	`+---`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +title: Welcome to MetricsJS
 +description: Streaming metrics for Node.js
 +---
++