Kitbook

Overview

The content provided is a set of instructions and information related to contributing to a project called Kitbook. The content mentions using Conventional Commits and provides instructions for working on Kitbook locally. It also mentions updating the Kitbook code and committing changes without breaking CI builds. Additionally, it mentions the relocation of Svelte Pieces to its own repository.

Features

• Roadmap: The content mentions a roadmap that provides guidance for contributing to the project.
• Conventional Commits: The content states that the project uses Conventional Commits as a guide for commit messages.
• Local Development: Provides instructions on how to work on Kitbook locally using pnpm.
• Updating Kitbook Code: Explains how to update the Kitbook code while using it in your own app.
• Committing Dependency Changes: Provides a way to commit the changed package.json dependency reference without breaking CI builds.
• Relocation of Svelte Pieces: Mentions that Svelte Pieces has been moved to its own repository.

Installation

To install Kitbook theme, follow these steps:

1. Open the desired project in Codeflow.
2. Set up Conventional Commits for better commit messages.
3. To work on Kitbook locally, execute the following commands:

   pnpm ipnpm stubpnpm dev
   

4. If you want to update the Kitbook code while using it in your own app, you can change your devDependency to point to it instead of npm by using the following command:

   "kitbook": "link:../kitbook/packages/kitbook"
   

   Then, run the following command in Kitbook to keep it updating on changes:

   pnpm package:watch
   

5. To commit the changed package.json dependency reference without breaking CI builds, change your build script to the following:

   pnpm install -F site kitbook && vite build
   

6. For Svelte Pieces, which has been moved to its own repository, you can find it [here](repository link).

Summary

The content provides instructions and information on contributing to Kitbook, a project. It mentions the use of Conventional Commits and provides installation instructions for working on Kitbook locally. It also provides guidance on updating the Kitbook code and committing changes without breaking CI builds. Finally, it mentions the relocation of Svelte Pieces to its own repository.