Socket
Socket
Sign inDemoInstall

@core-ds/components

Package Overview
Dependencies
24
Maintainers
8
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @core-ds/components

## Docz site


Version published
Weekly downloads
1
Maintainers
8
Install size
249 kB
Created
Weekly downloads
 

Readme

Source

Core Components

Docz site

Netlify Status

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.

  1. Make sure you have the repo cloned and Node installed
  2. npm install
  3. npm run docz:dev
  4. 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:
  1. cd to the root of the repo in cominor
  2. run Tests/Exec/deploy-core-components-docz-site.sh
  3. Once completed your console should output the "Live Draft URL"

FAQs

Last updated on 06 Aug 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc