Documentation is written using Markdown format.
Now our community team is accepting contributions from all community members of Genesis. All accepted contributions will be published on our official website.
Please check our Contributions guidr on Notion.
If you are willing to contribute, please follow the links below:
- Internal contributor if you are an internal contributor currently working at Genesis.
- External contributor if you are an external contributor not currently working at Genesis.
We have a Stack Overflow community. If you have a Genesis Login, take a look. Or, click here to get a new genesis login. We are encouraging our teams, customers and contributors to participate in this community.
npm i
npm run start
This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.
For a complete build, execute npm run build:
npm run build
If you prefer to run a local build only, we recommend using npm run build-main:
npm run build-main
Both commands generate static content into the build directory.
npm run clear
This command clears the Docusaurus generated assets, caches, build artefacts etc. This is useful if you're not seeing your changes in the browser.
To generate a new bundled file, simply run the following command from the package you wish to access.
npm run build
For example, in the foundation-ui repo we run the command above on the documentation-components under the showcase folder.
Ensure the package you intend to regenerate the file from has all the necessary dependencies.
Once you have the new regenerated file, paste the contents to docs.iife.min.js
Front-end documentation from foundation-ui can be pulled into this repo. To this, follow the steps below:
- Add as a dependency in
./package.json. - Set up the config in
./plugins/api-docs/manifest.json. - Set up the sidebar.
- Run with
$ npm run start:copy-docs. - Once you have got feedback on the docs, you can lock it in via
./plugins/api-docs/processedMap.js.