-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
15 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,25 @@ | ||
| # Starlight Starter Kit: Basics | ||
| # Verdi documentation | ||
|
|
||
| [](https://starlight.astro.build) | ||
| This repository contains the source code for https://docs.verdi.rocks/ | ||
|
|
||
| ``` | ||
| npm create astro@latest -- --template starlight | ||
| ``` | ||
|
|
||
| [](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) | ||
| [](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics) | ||
| [](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) | ||
|
|
||
| > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! | ||
| ## 🚀 Project Structure | ||
| To build locally ensure you have node 20+ installed with corepack enabled | ||
|
|
||
| Inside of your Astro + Starlight project, you'll see the following folders and files: | ||
| Install depedencies with pnpm | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| ``` | ||
| . | ||
| ├── public/ | ||
| ├── src/ | ||
| │ ├── assets/ | ||
| │ ├── content/ | ||
| │ │ ├── docs/ | ||
| │ │ └── config.ts | ||
| │ └── env.d.ts | ||
| ├── astro.config.mjs | ||
| ├── package.json | ||
| └── tsconfig.json | ||
| ``` | ||
|
|
||
| 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. | ||
|
|
||
| Images can be added to `src/assets/` and embedded in Markdown with a relative link. | ||
|
|
||
| Static assets, like favicons, can be placed in the `public/` directory. | ||
| Then run the development server with | ||
|
|
||
| ## 🧞 Commands | ||
|
|
||
| All commands are run from the root of the project, from a terminal: | ||
| ```bash | ||
| pnpm dev | ||
| ``` | ||
|
|
||
| | 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 | | ||
| This will make a development server available at http://localhost:4321 | ||
|
|
||
| ## 👀 Want to learn more? | ||
| ## License | ||
|
|
||
| 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). | ||
| This project is licensed under the | ||
| [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0). For more | ||
| information, please see the [LICENSE](LICENSE) file. |