{"id":13486793,"url":"https://github.com/johnlindquist/kit-docs","last_synced_at":"2025-03-19T21:31:15.736Z","repository":{"id":41450079,"uuid":"388918756","full_name":"johnlindquist/kit-docs","owner":"johnlindquist","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-28T19:51:28.000Z","size":3334,"stargazers_count":8,"open_issues_count":3,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-17T15:21:53.152Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://johnlindquist.github.io/kit-docs/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/johnlindquist.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-23T20:27:49.000Z","updated_at":"2025-03-12T14:46:52.000Z","dependencies_parsed_at":"2023-11-27T19:26:39.863Z","dependency_job_id":"3178b4a2-f000-459f-b130-c17bfbda160e","html_url":"https://github.com/johnlindquist/kit-docs","commit_stats":null,"previous_names":[],"tags_count":154,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnlindquist%2Fkit-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnlindquist%2Fkit-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnlindquist%2Fkit-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnlindquist%2Fkit-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johnlindquist","download_url":"https://codeload.github.com/johnlindquist/kit-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244507932,"owners_count":20463700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T18:00:51.194Z","updated_at":"2025-03-19T21:31:15.724Z","avatar_url":"https://github.com/johnlindquist.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003ca name=\"top\"\u003e\u003c/a\u003e\n# Script Kit Documentation\n\nThis repository contains documentation for [Script Kit](https://scriptkit.com).\n\nhttps://johnlindquist.github.io/kit-docs/\n\nWelcome to the kit-docs repository! \nThis repo hosts the documentation for [Script Kit](https://scriptkit.com/), an intuitive scripting toolkit \ndesigned to make scripting accessible and fun for developers of all skill levels.\n\n\u003e [!TIP]\n\u003e ### Quick Access in Script Kit\n\u003e You can quickly search the documentation directly from within Script Kit. Simply type `docs ` followed by a space, tab to\n\u003e a section, and then enter your search query. This feature allows you to conveniently explore the documentation right\n\u003e when and where you need it.\n\n## Repository Structure\n\n- `/` - The repository root contains the Markdown files for all the documentation. If you're looking to contribute or edit \n  the docs, this is where you'll find the files. Due to backwards compatibility with already released Kit versions, we cannot \n  create a dedicated `/docs` folder (see hardcoded file names in [download-md.ts](https://github.com/johnlindquist/kit/blob/main/src/cli/download-md.ts))\n- `/host` - This directory houses the [Docusaurus](https://docusaurus.io/) setup used to generate the documentation site. Docusaurus is a modern static website generator.\n\nSome markdown files at the repo root, such as this `README.md`, are ignored. See the `exclude` declaration in \n[host/docusaurus.config.mts](https://github.com/johnlindquist/kit-docs/blob/main/host/docusaurus.config.ts) for details.\n\n## Installation\n\nTo work with the documentation, you need to set up Docusaurus. This project uses modern [Yarn](https://yarnpkg.com/) \nas package manager. Here's how you can get started:\n\n1. We're assuming you have any Yarn executable installed on your machine.\n\n2. Navigate to the `/host` directory:\n\n    ```bash\n    cd host\n    ```\n\n3. Install the necessary dependencies:\n\n    ```bash\n    yarn install\n    ```\n\n4. To start the local development server, run:\n\n    ```bash\n    yarn start\n    ```\n\nThis will launch a local copy of the docs, allowing you to see your changes in real-time.\n\n## Contributing\n\nContributions to the Script Kit Docs are always welcome, whether it's editing existing documentation or adding new \ncontent. Please feel free to make a pull request or open an issue if you have suggestions or find any problems.\n\n## Using the Repository as a Kenv\n\nInterestingly, this repository is also technically a kenv, which means you can install it in Script Kit as such. \nThis makes it easier (for the maintainers) to manage and utilize scripts directly related to the documentation process.\n\n\n-----\n\n**Thank you for contributing to the Script Kit documentation!**\n\n[⬆️ Back to top](#top)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnlindquist%2Fkit-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohnlindquist%2Fkit-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnlindquist%2Fkit-docs/lists"}