Core Components
Docz site
https://core-design-components.netlify.com
See existing .mdx
files for examples on how to document a component.
Local Docz Server
You can build and serve the docz site locally.
- Make sure you have the repo cloned and Node installed
npm install
npm run docz:dev
- Any code changes should automatically reload the dev site!
Configuration
If you need to configure docz, it has a config file located at doczrc.js.
Options for netlify are found in UI/templates/js/netlify.toml
.
Deployment
Docz is deployed to Netlify automatically on merge to master using the Netlify CLI as part of our continuous integration.
The deploy script is located at Tests/Exec/deploy-core-components-docz-site.sh
To deploy a draft site:
cd
to the root of the repo in cominor- run
Tests/Exec/deploy-core-components-docz-site.sh
- Once completed your console should output the "Live Draft URL"