https://github.com/jacob-8/kitbook

Documentation, Prototyping, Inspection & Testing Workbench Tool for Svelte (SvelteKit Storybook alternative)
https://github.com/jacob-8/kitbook

component-driven-development components components-library documentation interface markdown prototyping svelte svelte-kit sveltejs ui visual-regression-testing

Last synced: 3 days ago
JSON representation

Documentation, Prototyping, Inspection & Testing Workbench Tool for Svelte (SvelteKit Storybook alternative)

• Host: GitHub
• URL: https://github.com/jacob-8/kitbook
• Owner: jacob-8
• License: mit
• Created: 2021-08-06T20:44:25.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-19T04:43:53.000Z (5 months ago)
• Last Synced: 2024-04-19T06:01:04.604Z (5 months ago)
• Topics: component-driven-development, components, components-library, documentation, interface, markdown, prototyping, svelte, svelte-kit, sveltejs, ui, visual-regression-testing
• Language: TypeScript
• Homepage: https://kitbook.vercel.app/
• Size: 3.6 MB
• Stars: 15
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        












Documentation, Prototyping, Inspection & Testing Workbench Tool for SvelteKit apps built with SvelteKit.





  





 View the Kitbook Docs (and demo)



## Contributing

Would love to have you help! Read the [[0-roadmap|Roadmap]] for good places to start. We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https:///pr.new/jacob-8/kitbook)

Or work on Kitbook locally:

- `pnpm install`

- `pnpm stub`

- `pnpm dev`

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 something like `"kitbook": "link:../kitbook/packages/kitbook",` then run `pnpm package:watch` in Kitbook to keep it updating on changes. 

[//begin]: # "Autogenerated link references for markdown compatibility"

[0-roadmap|Roadmap]: packages/kitbook/src/docs/9-maintainer-notes/0-roadmap.md "Roadmap"

[//end]: # "Autogenerated link references"