Skip to content

Commit a93fb9e

Browse files
committed
starlight init
0 parents  commit a93fb9e

14 files changed

+4497
-0
lines changed

.gitignore

+21
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

.vscode/extensions.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"recommendations": ["dbaeumer.vscode-eslint", "astro-build.astro-vscode", "unifiedjs.vscode-mdx"]
3+
}

.vscode/launch.json

+11
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+
}

README.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Bombshell Documentation
2+
3+
This directory contains the documentation for the different tools and features of Bombshell.
4+
5+
## Contributing
6+
7+
To contribute to the documentation:
8+
9+
1. Fork the repository
10+
2. Make your changes
11+
3. Submit a pull request
12+
13+
### Adding New Pages
14+
15+
To add a new page to the documentation:
16+
17+
1. Create a new Markdown file in the appropriate language directory (e.g., `en/`)
18+
2. Add frontmatter with `title` and `description`
19+
3. Update `config.json` to include the new page in the sidebar
20+
21+
Example frontmatter:
22+
23+
```md
24+
---
25+
title: My New Page
26+
description: Description of my new page
27+
---
28+
29+
# My New Page
30+
31+
Content goes here...
32+
```
33+
34+
### Editing Existing Pages
35+
36+
To edit an existing page:
37+
38+
1. Find the page in the appropriate language directory
39+
2. Make your changes
40+
3. Submit a pull request
41+
42+
## Integration with bomb.sh
43+
44+
This documentation is designed to be integrated with the bomb.sh website. The content in this directory will be pulled into the `/docs/clack/` route in the bomb.sh repository.
45+
46+
## Local Development
47+
48+
To preview the documentation locally, you'll need to clone the bomb.sh repository and set up the integration. Follow these steps:
49+
50+
1. Clone the bomb.sh repository
51+
2. Set up the integration to pull in this documentation
52+
3. Run the development server
53+
54+
See the bomb.sh repository for more detailed instructions on local development.

astro.config.mjs

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// @ts-check
2+
import { defineConfig } from 'astro/config';
3+
import starlight from '@astrojs/starlight';
4+
5+
// https://astro.build/config
6+
export default defineConfig({
7+
integrations: [
8+
starlight({
9+
title: 'My Docs',
10+
social: {
11+
github: 'https://github.com/withastro/starlight',
12+
},
13+
sidebar: [
14+
{
15+
label: 'Guides',
16+
items: [
17+
// Each item here is one entry in the navigation menu.
18+
{ label: 'Example Guide', slug: 'guides/example' },
19+
],
20+
},
21+
{
22+
label: 'Reference',
23+
autogenerate: { directory: 'reference' },
24+
},
25+
],
26+
}),
27+
],
28+
});

package.json

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "",
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.32.4",
14+
"astro": "^5.5.3",
15+
"sharp": "^0.32.5"
16+
}
17+
}

0 commit comments

Comments
 (0)