In order to use any exporter package, it must be installed in your workspace. This makes it available to any developer who has access to that workspace, which is ideal, especially with larger teams with more people responsible for maintaining the design system and the corresponding codebase.There are two ways to install an exporter package - through the Exporter Store, and through linking a GitHub repository containing the exporter package itself.
The first way to install an exporter is to go to Exporter Store and simply click the Install button on the exporter you want.
To install the exporter, find one that suits your needs and install it right from the Store interfaceWhen you install an exporter, it's available immediately for use. You can validate this by navigating to the Installed tab inside the Exporter store. All installed exporters for your current workspace will be listed there.
All exporters installed within the workspace will be available to all team members immediately.
Of course, exporters are not only useful on the Cloud, but also in the VS Code extension, where you can immediately request and write updated code using them. The installed exporters are available in the Supernova extension panel, under section "Available Exporters."
All exporters can be immediately run and used from both places.
In Supernova, all Exporters are backed by GitHub repositories (similarly to how NPM packages are built and deployed), which allows developers to use familiar and powerful Git features like versioning or forking - to allow making modifications to existing exporters while still getting updates from upstream.The Exporter Store is a "marketplace" (but completely free to everyone) which maintains the list of all exporters that community developers (and the Supernova team) have made publicly available for others to use. When you install an exporter (or create a new one and install it), it always starts as private, only available to your workspace. You can choose to publish the exporter if you feel it would be useful to other developers.
The second way to install an exporter is to directly link the repository in which its code is located. This is also how all exporters are made initially available to members of the workspace, until they are ready to be made public. In order to link a new GitHub exporter, go to Supernova Cloud > Code Integration > Store and tap + New. There, you can provide a GitHub repository to register:
Just copy-paste the repository URL and Store will register the exporter for youYou can again test that the exporter was installed by going to the Installed tab in the Store. The name, description and all other metadata about the exporter package will be taken from the exporter.json configuration file you will get to know later in this documentation. Now that you have the exporter installed, you can start using it right away.
This documentation was created using Supernova's fully customizable documentation engine.Start building your docs now!
© 2022 Supernova.io