Skip to content

Commit

Permalink
feat: Add FTL logo and update site title in Starlight configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
yarlson committed Dec 25, 2024
1 parent 7475d8f commit f25dd47
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 53 deletions.
4 changes: 0 additions & 4 deletions www/.vscode/extensions.json

This file was deleted.

11 changes: 0 additions & 11 deletions www/.vscode/launch.json

This file was deleted.

81 changes: 44 additions & 37 deletions www/README.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,61 @@
# Starlight Starter Kit: Basics
# FTL Documentation Site

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
Documentation site for [FTL (Faster Than Light Deployment)](https://github.com/yarlson/ftl) built with [Starlight](https://starlight.astro.build) and [Bun](https://bun.sh).

```
npm create astro@latest -- --template starlight
```
## Quick Start

```bash
# Install dependencies
bun install

# Start dev server
bun dev

[![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)
# Build for production
bun build

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
# Preview production build
bun preview
```

## 🚀 Project Structure
## Development

Inside of your Astro + Starlight project, you'll see the following folders and files:
The site uses Starlight's standard directory structure:

```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
src/
├── content/
│ └── docs/
│ └── ...mdx files
├── components/
└── assets/
```

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.
## Code Style

We use a combination of Prettier and Biome for formatting:

Images can be added to `src/assets/` and embedded in Markdown with a relative link.
- Prettier handles Astro and MDX files
- Biome handles JavaScript/TypeScript

Static assets, like favicons, can be placed in the `public/` directory.
Format all files:

```bash
bun format
```

## 🧞 Commands
## Contributing

All commands are run from the root of the project, from a terminal:
1. Make your changes
2. Run `bun format` before committing
3. Preview your changes with `bun preview`
4. Submit a PR

| 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 |
## Local Development with FTL

## 👀 Want to learn more?
To test documentation changes against local FTL changes:

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).
1. Clone FTL repo if you haven't already
2. Run docs site with `bun dev`
3. Make changes to both code and docs
4. Use `bun preview` to verify production build
7 changes: 6 additions & 1 deletion www/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ import starlight from "@astrojs/starlight";
export default defineConfig({
integrations: [
starlight({
title: "My Docs",
title: "FTL",
logo: {
light: "./src/assets/ftl-light.svg",
dark: "./src/assets/ftl-dark.svg",
replacesTitle: true,
},
customCss: [
"@fontsource-variable/rubik",
"@fontsource-variable/roboto-mono",
Expand Down
1 change: 1 addition & 0 deletions www/src/assets/ftl-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions www/src/assets/ftl-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f25dd47

Please sign in to comment.