Skip to content

Commit 493e3df

Browse files
committed
move docs
1 parent a92e24e commit 493e3df

34 files changed

Lines changed: 5612 additions & 34 deletions

docs/.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store

docs/.vscode/extensions.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"recommendations": ["astro-build.astro-vscode"],
3+
"unwantedRecommendations": []
4+
}

docs/.vscode/launch.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"command": "./node_modules/.bin/astro dev",
6+
"name": "Development server",
7+
"request": "launch",
8+
"type": "node-terminal"
9+
}
10+
]
11+
}

docs/README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Starlight Starter Kit: Basics
2+
3+
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
4+
5+
```
6+
pnpm create astro@latest -- --template starlight
7+
```
8+
9+
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
10+
11+
## 🚀 Project Structure
12+
13+
Inside of your Astro + Starlight project, you'll see the following folders and files:
14+
15+
```
16+
.
17+
├── public/
18+
├── src/
19+
│ ├── assets/
20+
│ ├── content/
21+
│ │ └── docs/
22+
│ └── content.config.ts
23+
├── astro.config.mjs
24+
├── package.json
25+
└── tsconfig.json
26+
```
27+
28+
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.
29+
30+
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
31+
32+
Static assets, like favicons, can be placed in the `public/` directory.
33+
34+
## 🧞 Commands
35+
36+
All commands are run from the root of the project, from a terminal:
37+
38+
| Command | Action |
39+
| :--------------------- | :----------------------------------------------- |
40+
| `pnpm install` | Installs dependencies |
41+
| `pnpm dev` | Starts local dev server at `localhost:4321` |
42+
| `pnpm build` | Build your production site to `./dist/` |
43+
| `pnpm preview` | Preview your build locally, before deploying |
44+
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
45+
| `pnpm astro -- --help` | Get help using the Astro CLI |
46+
47+
## 👀 Want to learn more?
48+
49+
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).

docs/astro.config.mjs

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
// @ts-check
2+
import { defineConfig, fontProviders } from "astro/config";
3+
import starlight from "@astrojs/starlight";
4+
5+
import mermaid from "astro-mermaid";
6+
import catppuccin from "@catppuccin/starlight";
7+
8+
// https://astro.build/config
9+
export default defineConfig({
10+
experimental: {
11+
fonts: [
12+
{
13+
provider: fontProviders.google(),
14+
name: "Victor Mono",
15+
cssVariable: "--sl-font",
16+
},
17+
],
18+
},
19+
integrations: [
20+
mermaid({
21+
theme: "forest",
22+
autoTheme: true,
23+
}),
24+
starlight({
25+
title: "nix-version",
26+
sidebar: [
27+
{
28+
label: "Getting Started",
29+
items: [
30+
{ label: "Installing", slug: "getting-started/installing" },
31+
{ label: "Listing package versions", slug: "getting-started/listing-versions" },
32+
{ label: "Finding packages", slug: "getting-started/finding-packages" },
33+
{ label: "CLI Help", slug: "getting-started/cli-help" },
34+
],
35+
},
36+
{
37+
label: "Guides",
38+
items: [
39+
{ label: "Tools Version Manager", slug: "tools-version-manager" },
40+
{ label: "Flake Generator", slug: "flake-generator" },
41+
{ label: "Non-Flake Environments", slug: "non-flake-environments" },
42+
{ label: "Installing packages on profiles", slug: "installing-packages-on-profiles" },
43+
],
44+
},
45+
],
46+
components: {
47+
Sidebar: "./src/components/Sidebar.astro",
48+
Footer: "./src/components/Footer.astro",
49+
SocialIcons: "./src/components/SocialIcons.astro",
50+
PageSidebar: "./src/components/PageSidebar.astro",
51+
},
52+
plugins: [
53+
catppuccin({
54+
dark: { flavor: "macchiato", accent: "mauve" },
55+
light: { flavor: "latte", accent: "mauve" },
56+
}),
57+
],
58+
editLink: {
59+
baseUrl: "https://github.com/vic/flake-file/edit/main/docs/",
60+
},
61+
customCss: ["./src/styles/custom.css"],
62+
}),
63+
],
64+
});

docs/package.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "nix-versions",
3+
"type": "module",
4+
"version": "0.0.1",
5+
"scripts": {
6+
"dev": "astro dev",
7+
"start": "astro dev",
8+
"build": "astro build",
9+
"preview": "astro preview",
10+
"astro": "astro"
11+
},
12+
"dependencies": {
13+
"@astrojs/starlight": "^0.37.6",
14+
"@catppuccin/starlight": "^1.1.1",
15+
"astro": "^5.17.3",
16+
"astro-mermaid": "^1.3.1",
17+
"mermaid": "^11.12.3",
18+
"sharp": "^0.34.5"
19+
}
20+
}

0 commit comments

Comments
 (0)