https://github.com/theotterlord/starlight-theme-template

Create and publish your own Starlight theme!
https://github.com/theotterlord/starlight-theme-template

starlight withastro

Last synced: 11 months ago
JSON representation

Create and publish your own Starlight theme!

• Host: GitHub
• URL: https://github.com/theotterlord/starlight-theme-template
• Owner: TheOtterlord
• License: mit
• Created: 2025-01-11T15:53:12.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-17T13:41:37.000Z (over 1 year ago)
• Last Synced: 2025-03-29T02:04:28.898Z (about 1 year ago)
• Topics: starlight, withastro
• Language: MDX
• Homepage:
• Size: 999 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Starlight Theme Template

Follow these steps to create your new Starlight theme.

- [ ] Update the package name, author, and URL in [packages/theme/package.json](packages/theme/package.json) and the [README](packages/theme/README.md), and remove `"private": true` from `package.json`.

- [ ] Update the dependency in [apps/docs/package.json](apps/docs/package.json) and [apps/docs/astro.config.ts](apps/docs/astro.config.ts) to your new theme package name.

- [ ] Update the [LICENSE](LICENSE) to include your name.

- [ ] Add your theme name/description/logos to the docs in [apps/docs/astro.config.ts](apps/docs/astro.config.ts).

- [ ] Add your custom styles to [packages/theme/styles/theme.css](packages/theme/styles/theme.css).

- [ ] Take a fancy screenshot of your theme and place it in [assets/preview.png](assets/preview.png)

- [ ] Add an `NPM_TOKEN` env variable to your GitHub repo.

- [ ] Deploy the docs to your favorite hosting provider.

- [ ] Run `pnpm changeset` and give your project a major bump for an initial release.

- [ ] Push/merge to main, and publish a release by merging the changeset PR.

- [ ] Delete this file, and run `ln -s packages/theme/README.md README2.md` to create a symlink to your package README, and share your theme with the world!