Create a beautiful documentation for your components writing dead simple files.
No rules. No loaders. No regex. Ship your docs with a couple of super simple declarations.
Support for legacy and modern frameworks. Perfect for companies migrating from AngularJS to Vue or React.
Prototype and share component compositions with your workmates.
Find out which components people are most interested in.
Use your own logo, favicon, window title and everything else you want.
Forever free and lovely crafted.
Pitsby is available via npm.
npm install -g @glorious/pitsby
Pitsby is based on two types of file. Choose a technology to see how simple they are.
Pitsby configuration should be created in the root directory of the project which you want the website will be created for. It’s responsible to tell Pitsby where *.doc.js files are, among other things.
You should create one *.doc.js file per component per engine. If your project makes components available for more than one technology, each one of them needs a *doc.js file.
Once you have set up a configuration file and, at least, one documentation file, you can easily generate the website running:
You can see the result serving it withor any other lib that you prefer:
You can optionally keep Pitsby watching the changes you make on any file listed on the configuration file. To do this, use the watch flag:
pitsby build --watch
The website will be running on http://localhost:7000.
Pitsby makes developers' life really easy. No hassle, no pain, only gain.
Easy and maintainable!
I love the playground feature. An easy and isolated way to play with components.
Pitsby is utterly awesome and easy - no more pain while documentating components, specially Vanilla!