Rename to “Starlight” (withastro#29)

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 [Astro contributors](https://github.com/withastro/starbook/graphs/contributors)
+Copyright (c) 2023 [Astro contributors](https://github.com/withastro/starlight/graphs/contributors)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/README.md

@@ -1,9 +1,9 @@
-# StarBook Docs
+# Starlight Docs
 
-This directory contains the StarBook documentation website (built with StarBook!)
+This directory contains the Starlight documentation website (built with Starlight!)
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starbook/tree/main/docs)
-[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starbook/tree/main/docs)
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/docs)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/docs)
 
 ## 🧞 Commands
 

docs/astro.config.mjs

@@ -1,13 +1,13 @@
 import { defineConfig } from 'astro/config';
-import starbook from 'starbook';
+import starlight from 'starlight';
 
 // https://astro.build/config
 export default defineConfig({
   integrations: [
-    starbook({
-      title: 'StarBook Docs',
+    starlight({
+      title: 'Starlight Docs',
       editLink: {
-        baseUrl: 'https://github.com/withastro/starbook/edit/main/docs/',
+        baseUrl: 'https://github.com/withastro/starlight/edit/main/docs/',
       },
       locales: {
         root: {

docs/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "starbook-docs",
+  "name": "starlight-docs",
   "private": true,
   "type": "module",
   "version": "0.0.1",
@@ -12,6 +12,6 @@
   },
   "dependencies": {
     "astro": "^2.1.7",
-    "starbook": "workspace:*"
+    "starlight": "workspace:*"
   }
 }

docs/src/content/config.ts

@@ -1,5 +1,5 @@
 import { defineCollection } from 'astro:content';
-import { docsSchema } from 'starbook/schema';
+import { docsSchema } from 'starlight/schema';
 
 export const collections = {
   docs: defineCollection({

docs/src/content/docs/getting-started.md

@@ -2,22 +2,22 @@
 title: Getting Started
 ---
 
-Welcome to StarBook, an intuitive and user-friendly website builder that allows you to easily create and manage your documentation website. In this introductory guide, we will explore the main features and benefits of StarBook.
+Welcome to Starlight, an intuitive and user-friendly website builder that allows you to easily create and manage your documentation website. In this introductory guide, we will explore the main features and benefits of Starlight.
 
-## Getting Started with StarBook
+## Getting Started with Starlight
 
-To get started with StarBook, you will first need to install it. StarBook is built on top of the [Astro](https://astro.build) all-in-one framework, which means you will also need to install Astro before installing StarBook. Once both are installed, you can create a new StarBook project using the following command:
+To get started with Starlight, you will first need to install it. Starlight is built on top of the [Astro](https://astro.build) all-in-one framework, which means you will also need to install Astro before installing Starlight. Once both are installed, you can create a new Starlight project using the following command:
 
 ```sh
 # create a new project with npm
-npm create astro --template starbook
+npm create astro --template starlight
 ```
 
 This will create a new project directory with all the necessary files and configurations for your documentation website.
 
-## Creating Content with StarBook
+## Creating Content with Starlight
 
-StarBook supports authoring content in Markdown and MDX, which means you can write your documentation using a simple and easy-to-learn syntax. You can also use a range of features and components supported by Docusaurus, GitBook, VitePress, MkDocs, Nextra, and Sphinx, including:
+Starlight supports authoring content in Markdown and MDX, which means you can write your documentation using a simple and easy-to-learn syntax. You can also use a range of features and components supported by Docusaurus, GitBook, VitePress, MkDocs, Nextra, and Sphinx, including:
 
 - Syntax highlighting for code blocks
 - Tables and lists
@@ -28,14 +28,14 @@ StarBook supports authoring content in Markdown and MDX, which means you can wri
 
 With these features, you can create rich and engaging documentation that is easy to read and understand.
 
-### Customizing Your StarBook Website
+### Customizing Your Starlight Website
 
-One of the main benefits of StarBook is its flexibility and customization options. You can easily customize your website's layout, theme, and styling using the Astro framework's built-in tools and features. For example, you can customize your website's color scheme, fonts, and typography, as well as add custom components and plugins.
+One of the main benefits of Starlight is its flexibility and customization options. You can easily customize your website's layout, theme, and styling using the Astro framework's built-in tools and features. For example, you can customize your website's color scheme, fonts, and typography, as well as add custom components and plugins.
 
-### Deploying Your StarBook Website
+### Deploying Your Starlight Website
 
-Once you have created and customized your StarBook website, you can deploy it to a web server or hosting platform of your choice. Astro provides built-in support for several popular hosting platforms, including Netlify and Vercel, which means you can deploy your website with just a few simple commands.
+Once you have created and customized your Starlight website, you can deploy it to a web server or hosting platform of your choice. Astro provides built-in support for several popular hosting platforms, including Netlify and Vercel, which means you can deploy your website with just a few simple commands.
 
 ## Conclusion
 
-StarBook is a powerful and flexible website builder that makes it easy to create and manage your documentation website. With support for Markdown and MDX, as well as a range of features and components, you can create rich and engaging content that is easy to read and understand. So why not give StarBook a try today and see how it can help you take your documentation to the next level!
+Starlight is a powerful and flexible website builder that makes it easy to create and manage your documentation website. With support for Markdown and MDX, as well as a range of features and components, you can create rich and engaging content that is easy to read and understand. So why not give Starlight a try today and see how it can help you take your documentation to the next level!

docs/src/content/docs/guides/i18n.md

@@ -2,20 +2,20 @@
 title: Internationalization (i18n)
 ---
 
-StarBook provides built-in support for multilingual sites.
+Starlight provides built-in support for multilingual sites.
 
 ## Configure i18n
 
-1. Tell StarBook about the languages you support by passing a `locales` object to the StarBook integration:
+1. Tell Starlight about the languages you support by passing a `locales` object to the Starlight integration:
 
    ```js
    // astro.config.mjs
    import { defineConfig } from 'astro/config';
-   import starbook from 'starbook';
+   import starlight from 'starlight';
 
    export default defineConfig({
      integrations: [
-       starbook({
+       starlight({
          // Set English as the default language for this site.
          defaultLocale: 'en',
          locales: {

docs/src/content/docs/index.mdx

@@ -2,7 +2,7 @@
 title: Welcome, world
 ---
 
-My docs are built with StarBook.
+My docs are built with Starlight.
 
 :::tip[Did you know?]
 Astro helps you build faster websites with [“Islands Architecture”](https://docs.astro.build/en/concepts/islands/).

docs/src/content/docs/reference/configuration.md

@@ -2,9 +2,9 @@
 title: Configuration Reference
 ---
 
-## Configure the `starbook` integration
+## Configure the `starlight` integration
 
-You can pass the following options to the `starbook` integration.
+You can pass the following options to the `starlight` integration.
 
 ### `title` (required)
 
@@ -29,17 +29,17 @@ Configure the table of contents shown on the right of each page. By default, `<h
 
 **type:** `{ baseUrl: string }`
 
-Enable “Edit this page” links by setting the base URL these should use. The final link will be `editLink.baseUrl` + the current page path. For example, to enable editing pages in the `withastro/starbook` repo on GitHub:
+Enable “Edit this page” links by setting the base URL these should use. The final link will be `editLink.baseUrl` + the current page path. For example, to enable editing pages in the `withastro/starlight` repo on GitHub:
 
 ```js
-starbook({
+starlight({
   editLink: {
-    baseUrl: 'https://github.com/withastro/starbook/edit/main/',
+    baseUrl: 'https://github.com/withastro/starlight/edit/main/',
   },
 });
 ```
 
-With this config, a `/introduction` page would have an edit link pointing to `https://github.com/withastro/starbook/edit/main/src/docs/introduction.md`.
+With this config, a `/introduction` page would have an edit link pointing to `https://github.com/withastro/starlight/edit/main/src/docs/introduction.md`.
 
 ### `sidebar`
 
@@ -52,7 +52,7 @@ A sidebar is an array of groups, each with a `label` for the group and either an
 You can manually set the contents of a group using `items`, which is an array that can include links and subgroups. You can also automatically generate the contents of a group from a specific directory of your docs, using `autogenerate`.
 
 ```js
-starbook({
+starlight({
   sidebar: [
     // A group labelled “Start Here” containing two links.
     {
@@ -109,11 +109,11 @@ Each entry should use the directory where that language’s files are saved as t
 ```js
 // astro.config.mjs
 import { defineConfig } from 'astro/config';
-import starbook from 'starbook';
+import starlight from 'starlight';
 
 export default defineConfig({
   integrations: [
-    starbook({
+    starlight({
       // Set English as the default language for this site.
       defaultLocale: 'en',
       locales: {
@@ -164,7 +164,7 @@ The writing direction of this language; `"ltr"` for left-to-right (the default)
 You can serve the default language without a `/lang/` directory by setting a `root` locale:
 
 ```js
-starbook({
+starlight({
   locales: {
     root: {
       label: 'English',
@@ -194,7 +194,7 @@ The default locale will be used to provide fallback content where translations a
 Optional details about the social media accounts for this site.
 
 ```js
-starbook({
+starlight({
   social: {
     // Main Twitter handle for this site
     twitter: 'astrodotbuild',
@@ -204,12 +204,12 @@ starbook({
 
 ### `customCss`
 
-Provide CSS files to customize the look and feel of StarBook.
+Provide CSS files to customize the look and feel of your Starlight site.
 
 Supports local CSS files relative to the root of your project, e.g. `'/src/custom.css'`, and CSS you installed as an npm module, e.g. `'@fontsource/roboto'`.
 
 ```js
-starbook({
+starlight({
   customCss: ['/src/custom-styles.css', '@fontsource/roboto'],
 });
 ```

docs/src/content/docs/reference/markdown-syntax.md

@@ -2,7 +2,7 @@
 title: Markdown Syntax
 ---
 
-StarBook supports the full range of Markdown syntax.
+Starlight supports the full range of Markdown syntax.
 
 ## Inline styles
 
@@ -54,27 +54,27 @@ You can structure content using a heading. Headings in Markdown are indicated by
 
 Asides (also known as “admonitions” or “callouts”) are useful for displaying secondary information alongside a page’s main content.
 
-StarBook provides a custom Markdown syntax for rendering asides. Aside blocks are indicated using a triple colon `:::` and can be of type `note`, `tip`, `caution` or `danger`.
+Starlight provides a custom Markdown syntax for rendering asides. Aside blocks are indicated using a triple colon `:::` and can be of type `note`, `tip`, `caution` or `danger`.
 
 You can nest any other Markdown content types inside an aside, but asides are best suited to short and concise chunks of content.
 
 ### Note aside
 
 :::note
-StarBook is a documentation website toolkit built with [Astro](https://astro.build/). You can get started with this command:
+Starlight is a documentation website toolkit built with [Astro](https://astro.build/). You can get started with this command:
 
 ```sh
-npm run create astro@latest --template starbook
+npm run create astro@latest --template starlight
 ```
 
 :::
 
 ````md
 :::note
-StarBook is a documentation website toolkit built with [Astro](https://astro.build/). You can get started with this command:
+Starlight is a documentation website toolkit built with [Astro](https://astro.build/). You can get started with this command:
 
 ```sh
-npm run create astro@latest --template starbook
+npm run create astro@latest --template starlight
 ```
 
 :::
@@ -100,11 +100,11 @@ Caution and danger asides are helpful for drawing a user’s attention to detail
 If you find yourself using these a lot, it may also be a sign that the thing you are documenting could benefit from being redesigned.
 
 :::caution
-If you are not sure you want an awesome docs site, think twice before using [StarBook](../../).
+If you are not sure you want an awesome docs site, think twice before using [Starlight](../../).
 :::
 
 :::danger
-Your users may be more productive and find your product easier to use thanks to helpful StarBook features.
+Your users may be more productive and find your product easier to use thanks to helpful Starlight features.
 
 - Clear navigation
 - User-configurable colour theme
@@ -114,11 +114,11 @@ Your users may be more productive and find your product easier to use thanks to
 
 ```md
 :::caution
-If you are not sure you want an awesome docs site, think twice before using [StarBook](../../).
+If you are not sure you want an awesome docs site, think twice before using [Starlight](../../).
 :::
 
 :::danger
-Your users may be more productive and find your product easier to use thanks to helpful StarBook features.
+Your users may be more productive and find your product easier to use thanks to helpful Starlight features.
 
 - Clear navigation
 - User-configurable colour theme

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "starbook-root",
+  "name": "starlight-root",
   "private": true,
   "version": "1.0.0",
   "description": "",