Skip to content

Commit 91564d9

Browse files
committed
Update README to reflect project name change from Starlight Starter Kit to BrowserSec
1 parent cfa36c7 commit 91564d9

File tree

1 file changed

+2
-37
lines changed

1 file changed

+2
-37
lines changed

README.md

Lines changed: 2 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,11 @@
1-
# Starlight Starter Kit: Basics
1+
## BrowserSec
22

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

5-
```
6-
pnpm create astro@latest -- --template starlight
7-
```
85

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)
11-
[![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)
12-
[![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)
136

14-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
157

16-
## 🚀 Project Structure
17-
18-
Inside of your Astro + Starlight project, you'll see the following folders and files:
19-
20-
```
21-
.
22-
├── public/
23-
├── src/
24-
│ ├── assets/
25-
│ ├── content/
26-
│ │ ├── docs/
27-
│ └── content.config.ts
28-
├── astro.config.mjs
29-
├── package.json
30-
└── tsconfig.json
31-
```
32-
33-
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.
34-
35-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
36-
37-
Static assets, like favicons, can be placed in the `public/` directory.
38-
39-
## 🧞 Commands
8+
### 🧞 Commands
409

4110
All commands are run from the root of the project, from a terminal:
4211

@@ -48,7 +17,3 @@ All commands are run from the root of the project, from a terminal:
4817
| `pnpm preview` | Preview your build locally, before deploying |
4918
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
5019
| `pnpm astro -- --help` | Get help using the Astro CLI |
51-
52-
## 👀 Want to learn more?
53-
54-
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).

0 commit comments

Comments
 (0)