https://github.com/svelte-docgen/svelte-docgen
Effortless documentation for Svelte components
https://github.com/svelte-docgen/svelte-docgen
component docgen documentation svelte
Last synced: about 1 year ago
JSON representation
Effortless documentation for Svelte components
- Host: GitHub
- URL: https://github.com/svelte-docgen/svelte-docgen
- Owner: svelte-docgen
- License: mit
- Created: 2024-11-15T02:09:32.000Z (over 1 year ago)
- Default Branch: next
- Last Pushed: 2025-02-05T03:55:54.000Z (over 1 year ago)
- Last Synced: 2025-04-09T22:13:18.837Z (about 1 year ago)
- Topics: component, docgen, documentation, svelte
- Language: TypeScript
- Homepage: https://svelte-docgen.pages.dev
- Size: 9.7 MB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# `svelte-docgen`
This project is a monorepo for [`svelte-docgen`](./packages/svelte-docgen) related packages.
> [!WARNING]
> This project is still a work in progress. [See roadmap for `v1`](https://github.com/svelte-docgen/svelte-docgen/issues/5).
## Packages
| Package | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [`svelte-docgen`](./packages/svelte-docgen) | Core package |
| `@svelte-docgen/cli` [🚧 Tracking](https://github.com/svelte-docgen/svelte-docgen/issues/9) | Standalone CLI |
| [`@svelte-docgen/extractor`](./packages/extractor) | Extracting types from `*.svelte` files to write your own |
| [`@svelte-docgen/server`](./packages/server) | Run a server which allows fetching docs on demand |
| [`vite-plugin-svelte-docgen`](./packages/vite-plugin-svelte-docgen) | [Vite](https://github.com/vitejs/vite) plugin which creates virtual files for your Svelte docgen data - on demand. |
---
## Contributing
Take a look at the [contributing guide](./.github/CONTRIBUTING.md).
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
**Contributions of any kind are welcome!**
💌 to these people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Mateusz Kadlubowski
💻 🚇 🚧
Taku Fukada
💻 🚇 🚧
> [!NOTE]
> We also put a lot of effort to make this project [e18e](https://e18e.dev/)-friendly.
### Support
If you don't have time, but you need this project to work, or resolve an existing issue, consider [sponsorship](https://github.com/sponsors/svelte-docgen).
---
## Authors
- Mateusz "[xeho91](https://github.com/xeho91)" Kadlubowski
- Taku "[ciscorn](https://github.com/ciscorn)" Fukada