Skip to content

svelte-docgen/svelte-docgen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

129 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

svelte-docgen logo
GitHub Actions Workflow Status Codecov icon

svelte-docgen

This project is a monorepo for svelte-docgen related packages.

Warning

This project is still a work in progress. See roadmap for v1.

Packages

Package Description
svelte-docgen Core package
@svelte-docgen/cli 🚧 Tracking Standalone CLI
@svelte-docgen/extractor Extracting types from *.svelte files to write your own
@svelte-docgen/server Run a server which allows fetching docs on demand
vite-plugin-svelte-docgen Vite plugin which creates virtual files for your Svelte docgen data - on demand.

Contributing

Take a look at the contributing guide.

This project follows the all-contributors specification. Contributions of any kind are welcome!

💌 to these people (emoji key):

Mateusz Kadlubowski
Mateusz Kadlubowski

💻 🚇 🚧
Taku Fukada
Taku Fukada

💻 🚇 🚧

Note

We also put a lot of effort to make this project e18e-friendly.

Support

If you don't have time, but you need this project to work, or resolve an existing issue, consider sponsorship.


Authors

About

Effortless documentation for Svelte components

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

Contributors