Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @iasthc
9 changes: 9 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Package Managers
package-lock.json
pnpm-lock.yaml
yarn.lock
bun.lock
bun.lockb

# Miscellaneous
/static/
6 changes: 6 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"useTabs": true,
"singleQuote": true,
"trailingComma": "none",
"printWidth": 100
}
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Starlight Starter Kit: Basics
# Starlight Starter Kit: Tailwind

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

```
pnpm create astro@latest -- --template starlight
pnpm create astro@latest -- --template starlight/tailwind
```

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
Expand All @@ -19,6 +19,8 @@ Inside of your Astro + Starlight project, you'll see the following folders and f
│ ├── assets/
│ ├── content/
│ │ └── docs/
│ ├── styles/
│ │ └── global.css
│ └── content.config.ts
├── astro.config.mjs
├── package.json
Expand All @@ -31,13 +33,15 @@ Images can be added to `src/assets/` and embedded in Markdown with a relative li

Static assets, like favicons, can be placed in the `public/` directory.

The project includes [Tailwind CSS](https://starlight.astro.build/guides/css-and-tailwind/#tailwind-css) for styling. Customize your design by modifying `src/styles/global.css`.

## 🧞 Commands

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

| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| Command | Action |
| :--------------------- | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm dev` | Starts local dev server at `localhost:4321` |
| `pnpm build` | Build your production site to `./dist/` |
| `pnpm preview` | Preview your build locally, before deploying |
Expand Down
52 changes: 46 additions & 6 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,27 +1,67 @@
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import tailwindcss from '@tailwindcss/vite';
import starlightOpenAPI, { openAPISidebarGroups } from 'starlight-openapi';

// https://astro.build/config
export default defineConfig({
site: 'https://otterscale.com',
integrations: [
starlight({
title: 'My Docs',
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }],
title: 'OtterScale',
logo: {
src: './src/assets/logo.png'
},
social: [
{
icon: 'github',
label: 'GitHub',
href: 'https://github.com/otterscale/otterscale'
}
],
defaultLocale: 'root',
locales: {
root: {
label: 'English',
lang: 'en'
},
'zh-hant': {
label: '繁體中文',
lang: 'zh-Hant'
}
},
editLink: {
baseUrl: 'https://github.com/otterscale/otterscale.github.io/edit/main/docs/'
},
sidebar: [
{
label: 'Guides',
items: [
// Each item here is one entry in the navigation menu.
{ label: 'Example Guide', slug: 'guides/example' },
],
{ label: 'Example Guide', slug: 'guides/example' }
]
},
{
label: 'Reference',
autogenerate: { directory: 'reference' },
autogenerate: { directory: 'reference' }
},
...openAPISidebarGroups
],
}),
customCss: ['./src/styles/global.css'],
plugins: [
// Generate the OpenAPI documentation pages.
starlightOpenAPI([
{
base: 'api',
schema:
'https://raw.githubusercontent.com/otterscale/otterscale/refs/heads/main/api/openapi.yaml'
}
])
]
})
],
vite: {
plugins: [tailwindcss()]
}
});
8 changes: 7 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,13 @@
},
"dependencies": {
"@astrojs/starlight": "^0.36.2",
"@astrojs/starlight-tailwind": "^4.0.2",
"@fontsource/geist": "^5.2.8",
"@fontsource/geist-mono": "^5.2.7",
"@tailwindcss/vite": "^4.0.7",
"astro": "^5.6.1",
"sharp": "^0.34.2"
"sharp": "^0.34.2",
"starlight-openapi": "^0.21.1",
"tailwindcss": "^4.0.7"
}
}
Loading
Loading