https://johnlindquist.github.io/kit-docs/

Welcome to the kit-docs repository! This repo hosts the documentation for Script Kit, an intuitive scripting toolkit designed to make scripting accessible and fun for developers of all skill levels.

• / - The repository root contains the Markdown files for all the documentation. If you're looking to contribute or edit the docs, this is where you'll find the files. Due to backwards compatibility with already released Kit versions, we cannot create a dedicated /docs folder (see hardcoded file names in download-md.ts)
• /host - This directory houses the Docusaurus setup used to generate the documentation site. Docusaurus is a modern static website generator.

Some markdown files at the repo root, such as this README.md, are ignored. See the exclude declaration in host/docusaurus.config.mts for details.

To work with the documentation, you need to set up Docusaurus. This project uses modern Yarn as package manager. Here’s how you can get started:

1. We're assuming you have any Yarn executable installed on your machine.

2. Navigate to the /host directory:

   cd host

3. Install the necessary dependencies:

   yarn install

4. To start the local development server, run:

   yarn start

This will launch a local copy of the docs, allowing you to see your changes in real-time.

Contributions to the Script Kit Docs are always welcome, whether it's editing existing documentation or adding new content. Please feel free to make a pull request or open an issue if you have suggestions or find any problems.

Interestingly, this repository is also technically a kenv, which means you can install it in Script Kit as such. This makes it easier (for the maintainers) to manage and utilize scripts directly related to the documentation process.

Thank you for contributing to the Script Kit documentation!

⬆️ Back to top