Skip to content

Commit

Permalink
har.fyi
Browse files Browse the repository at this point in the history
  • Loading branch information
rviscomi committed Jun 5, 2023
1 parent 2634cd0 commit 742d7cf
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 32 deletions.
35 changes: 5 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,17 @@
# Starlight Starter Kit: Basics
# har.fyi

```
npm create astro@latest -- --template starlight
```
## πŸš€ Project structure

[![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)

> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun!
## πŸš€ Project Structure

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

```
.
β”œβ”€β”€ public/
β”œβ”€β”€ src/
β”‚ β”œβ”€β”€ assets/
β”‚ β”œβ”€β”€ content/
β”‚ β”‚ β”œβ”€β”€ docs/
β”‚ β”‚ └── config.ts
β”‚ └── env.d.ts
β”œβ”€β”€ astro.config.mjs
β”œβ”€β”€ package.json
└── tsconfig.json
```
These docs are powered by Starlight by Astro.

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.

For more info, 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).

## 🧞 Commands

All commands are run from the root of the project, from a terminal:
Expand All @@ -45,7 +24,3 @@ All commands are run from the root of the project, from a terminal:
| `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?

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).
4 changes: 2 additions & 2 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ export default defineConfig({
site: 'https://har.fyi',
integrations: [
starlight({
title: 'My Docs',
title: 'har.fyi',
social: {
github: 'https://github.com/withastro/starlight',
github: 'https://github.com/rviscomi/har.fyi',
},
sidebar: [
{
Expand Down

0 comments on commit 742d7cf

Please sign in to comment.