https://github.com/vtex/andromedocs

andromedocs provides simple yet flexible tools for documenting Design Systems.
https://github.com/vtex/andromedocs

design-system documentation gatsby hacktoberfest

Last synced: about 1 month ago
JSON representation

andromedocs provides simple yet flexible tools for documenting Design Systems.

• Host: GitHub
• URL: https://github.com/vtex/andromedocs
• Owner: vtex
• License: mit
• Created: 2020-09-11T13:30:41.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-27T21:09:51.000Z (about 4 years ago)
• Last Synced: 2024-04-14T22:51:50.703Z (9 months ago)
• Topics: design-system, documentation, gatsby, hacktoberfest
• Language: TypeScript
• Homepage:
• Size: 781 KB
• Stars: 10
• Watchers: 7
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# andromedocs 🚀📝

`andromedocs` provides simple yet flexible tools for documenting Design Systems. This project and its documentation are currently in development and, therefore, are undergoing frequent changes.

## Usage

This project has not been deployed yet, so it cannot be imported directly at the moment. However, a usage example is being developed and can be consulted in the `docs` folder.

## Contributing

Refer to our [contributing guidelines](./CONTRIBUTING.md).

## Components

The `components` package consists of components that can come in handy for documenting a DS.

### Running locally

You can run `yarn storybook:components` to execute Storybook locally and check out some examples of how the components can be used.

### Component list

#### Status Tag

Displays the current status of the component, usually stable, experimental, or deprecated, to indicate if it is safe to utilize it.

#### Guidelines

Provides orientation on how a component should (**Dos**) and should not (**Don'ts**) be used.

## Gatsby Theme

The andromedocs Gatsby theme provides a framework to build documentation pages with the support of MDX (Markdown + JSX).

### Running locally

Run `yarn develop:theme` to run the andromedocs theme in development mode.