Valde is an incubator for Catalog extensions. The project consists of multiple, independent packages which help you create beautiful documentation pages.
The packages cover a wide range of topics and use cases. Some packages offer just React components, while others also include guidelines how to structure whole sections of your documentation.
- @valde/iconography: Document individual icons or a complete icon set.
- @valde/typography: Document, explain and test the typography choices (typefaces, fonts etc).
If you have an idea for a package describe it in a GitHub issue, or even start working on it yourself.
No packages in this section.
- @valde/tabbed-page: Gives you more control for structuring the content through the use of tabs.
- @valde/react-component-page: An experiment to use a whole page to document one component.
The first step is to add the package to your project:
npm install --save @valde/<package>
Detailed documentation how to use each package is available on the respective documentation pages.
Follow the instructions in the Contributing section of the documentation.
No manual work is required to publish the website. All changes, including pull requests, are automatically deployed through now.
Note: Old deployments linger around and need to be cleaned up manually. To delete old, unused deployments use now rm valde --safe --yes.
The packages are automatically published to npm when you push tags to GitHub (via GitHub Actions).
- Use
lerna versionto bump the versions and create Git tags. Be careful when deciding whether the changes require a major, minor or patch version bump. - Push tags to GitHub:
git push
That's it, the packages should become available on npm within a few minutes 🍾