Skip to content

Commit

Permalink
Move to Starlight for Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Malfrador committed Oct 26, 2024
1 parent 77e34d3 commit 2671edc
Show file tree
Hide file tree
Showing 135 changed files with 5,918 additions and 38,494 deletions.
52 changes: 0 additions & 52 deletions .github/workflows/build-docker-image.yml

This file was deleted.

31 changes: 16 additions & 15 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# Dependencies
/node_modules
# build output
dist/
# generated types
.astro/

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
# 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
3 changes: 0 additions & 3 deletions .idea/.gitignore

This file was deleted.

7 changes: 0 additions & 7 deletions .idea/discord.xml

This file was deleted.

9 changes: 0 additions & 9 deletions .idea/inspectionProfiles/Project_Default.xml

This file was deleted.

6 changes: 0 additions & 6 deletions .idea/misc.xml

This file was deleted.

8 changes: 0 additions & 8 deletions .idea/modules.xml

This file was deleted.

6 changes: 0 additions & 6 deletions .idea/vcs.xml

This file was deleted.

4 changes: 4 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}
11 changes: 11 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}
29 changes: 0 additions & 29 deletions Dockerfile

This file was deleted.

60 changes: 37 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,55 @@
# Website
# Starlight Starter Kit: Basics

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

```
$ yarn
npm create astro@latest -- --template starlight
```

### Local Development
[![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 to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=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)

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

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

```
$ yarn build
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
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.

### Deployment
Images can be added to `src/assets/` and embedded in Markdown with a relative link.

Using SSH:
Static assets, like favicons, can be placed in the `public/` directory.

```
$ USE_SSH=true yarn deploy
```
## 🧞 Commands

Not using SSH:
All commands are run from the root of the project, from a terminal:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```
| 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?

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
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).
19 changes: 19 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'Erethon Docs',
social: {
github: 'https://github.com/DRE2N',
},
customCss: [
// Relative path to your custom CSS file
'./src/styles/custom.css',
],
}),
],
});
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

4 changes: 0 additions & 4 deletions docs/aergia/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docs/aether/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docs/bedrock/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docs/dungeonsxl/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docs/questsxl/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions docs/spellbook/_category_.json

This file was deleted.

Loading

0 comments on commit 2671edc

Please sign in to comment.