Skip to content

Commit 11cb3b5

Browse files
Uzaaftmehalter
authored andcommitted
feat!: Rewrite docs to Astro.js and starlight
1 parent 71e86a3 commit 11cb3b5

File tree

925 files changed

+4704
-126700
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

925 files changed

+4704
-126700
lines changed

.gitignore

Lines changed: 14 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,116 +1,22 @@
1-
# Logs
2-
logs
3-
*.log
4-
npm-debug.log*
5-
yarn-debug.log*
6-
yarn-error.log*
7-
lerna-debug.log*
8-
9-
# Diagnostic reports (https://nodejs.org/api/report.html)
10-
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11-
12-
# Runtime data
13-
pids
14-
*.pid
15-
*.seed
16-
*.pid.lock
17-
18-
# Directory for instrumented libs generated by jscoverage/JSCover
19-
lib-cov
20-
21-
# Coverage directory used by tools like istanbul
22-
coverage
23-
*.lcov
24-
25-
# nyc test coverage
26-
.nyc_output
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
275

28-
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29-
.grunt
30-
31-
# Bower dependency directory (https://bower.io/)
32-
bower_components
33-
34-
# node-waf configuration
35-
.lock-wscript
36-
37-
# Compiled binary addons (https://nodejs.org/api/addons.html)
38-
build/Release
39-
40-
# Dependency directories
6+
# dependencies
417
node_modules/
42-
jspm_packages/
43-
44-
# TypeScript v1 declaration files
45-
typings/
46-
47-
# TypeScript cache
48-
*.tsbuildinfo
49-
50-
# Optional npm cache directory
51-
.npm
52-
53-
# Optional eslint cache
54-
.eslintcache
558

56-
# Microbundle cache
57-
.rpt2_cache/
58-
.rts2_cache_cjs/
59-
.rts2_cache_es/
60-
.rts2_cache_umd/
61-
62-
# Optional REPL history
63-
.node_repl_history
64-
65-
# Output of 'npm pack'
66-
*.tgz
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
6714

68-
# Yarn Integrity file
69-
.yarn-integrity
7015

71-
# dotenv environment variables file
16+
# environment variables
7217
.env
73-
.env.test
74-
.env.local
75-
.env.development.local
76-
.env.test.local
77-
.env.production.local
78-
79-
# parcel-bundler cache (https://parceljs.org/)
80-
.cache
81-
82-
# Next.js build output
83-
.next
84-
85-
# Nuxt.js build / generate output
86-
.nuxt
87-
dist
88-
89-
# Gatsby files
90-
.cache/
91-
# Comment in the public line in if your project uses Gatsby and *not* Next.js
92-
# https://nextjs.org/blog/next-9-1#public-directory-support
93-
# public
94-
95-
# vuepress build output
96-
.vuepress/dist
97-
98-
# Serverless directories
99-
.serverless/
100-
101-
# FuseBox cache
102-
.fusebox/
103-
104-
# DynamoDB Local files
105-
.dynamodb/
106-
107-
# TernJS port file
108-
.tern-port
109-
110-
# Docusaurus files
111-
/build
112-
.docusaurus
113-
.cache-loader
18+
.env.production
11419

115-
# Misc
20+
# macOS-specific files
11621
.DS_Store
22+
.vercel

LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

README.md

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,53 @@
1-
# AstroNvim Website
1+
# Starlight Starter Kit: Basics
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4-
5-
### Installation
3+
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
64

75
```
8-
$ yarn
6+
npm create astro@latest -- --template starlight
97
```
108

11-
### Local Development
9+
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10+
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
1211

13-
```
14-
$ yarn start
15-
```
12+
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
1613
17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
14+
## 🚀 Project Structure
1815

19-
### Build
16+
Inside of your Astro + Starlight project, you'll see the following folders and files:
2017

2118
```
22-
$ yarn build
19+
.
20+
├── public/
21+
├── src/
22+
│ ├── assets/
23+
│ ├── content/
24+
│ │ ├── docs/
25+
│ │ └── config.ts
26+
│ └── env.d.ts
27+
├── astro.config.mjs
28+
├── package.json
29+
└── tsconfig.json
2330
```
2431

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
32+
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.
33+
34+
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
35+
36+
Static assets, like favicons, can be placed in the `public/` directory.
37+
38+
## 🧞 Commands
39+
40+
All commands are run from the root of the project, from a terminal:
41+
42+
| Command | Action |
43+
| :------------------------ | :----------------------------------------------- |
44+
| `npm install` | Installs dependencies |
45+
| `npm run dev` | Starts local dev server at `localhost:4321` |
46+
| `npm run build` | Build your production site to `./dist/` |
47+
| `npm run preview` | Preview your build locally, before deploying |
48+
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
49+
| `npm run astro -- --help` | Get help using the Astro CLI |
50+
51+
## 👀 Want to learn more?
52+
53+
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).

astro.config.mjs

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
import { defineConfig } from "astro/config";
2+
import starlight from "@astrojs/starlight";
3+
4+
import tailwind from "@astrojs/tailwind";
5+
6+
// https://astro.build/config
7+
export default defineConfig({
8+
site: "https://astrodocs-v2.vercel.app",
9+
integrations: [
10+
starlight({
11+
title: "AstroNvim",
12+
logo: {
13+
src: "./src/assets/logo/astronvim.svg",
14+
},
15+
customCss: [
16+
// Path to your Tailwind base styles:
17+
"./src/tailwind.css",
18+
],
19+
social: {
20+
github: "https://github.com/AstroNvim/AstroNvim",
21+
// reddit: "https://www.reddit.com/r/AstroNvim/",
22+
discord: "https://discord.astronvim.com",
23+
twitter: "https://twitter.com/AstroNvim",
24+
mastodon: "https://hachyderm.io/@AstroNvim",
25+
},
26+
sidebar: [
27+
{
28+
label: "Getting started",
29+
link: "/",
30+
collapsed: true,
31+
},
32+
{
33+
label: "Basic Usage",
34+
collapsed: true,
35+
autogenerate: {
36+
directory: "basic-usage",
37+
},
38+
},
39+
{
40+
label: "Configuration",
41+
collapsed: true,
42+
autogenerate: {
43+
directory: "Configuration",
44+
},
45+
},
46+
{
47+
label: "Recipes",
48+
collapsed: true,
49+
autogenerate: {
50+
directory: "Recipes",
51+
},
52+
},
53+
{
54+
label: "Acknowledgements",
55+
link: "/acknowledgements",
56+
collapsed: true,
57+
},
58+
{
59+
label: "Code of Conduct",
60+
collapsed: true,
61+
link: "/code_of_conduct",
62+
},
63+
{
64+
label: "Frequently asked questions",
65+
collapsed: true,
66+
link: "/faq",
67+
},
68+
{
69+
label: "Core Lua API Documentation",
70+
link: "https://api.astronvim.com",
71+
},
72+
],
73+
}),
74+
tailwind({
75+
// Disable the default base styles:
76+
applyBaseStyles: false,
77+
}),
78+
],
79+
});

babel.config.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)