{"id":21835868,"url":"https://github.com/vtex/andromedocs","last_synced_at":"2025-04-14T09:15:17.946Z","repository":{"id":56077242,"uuid":"294703322","full_name":"vtex/andromedocs","owner":"vtex","description":"andromedocs provides simple yet flexible tools for documenting Design Systems.","archived":false,"fork":false,"pushed_at":"2020-11-27T21:09:51.000Z","size":800,"stargazers_count":10,"open_issues_count":3,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-14T09:15:02.454Z","etag":null,"topics":["design-system","documentation","gatsby","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vtex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-11T13:30:41.000Z","updated_at":"2023-05-12T17:00:32.000Z","dependencies_parsed_at":"2022-08-15T12:40:56.081Z","dependency_job_id":null,"html_url":"https://github.com/vtex/andromedocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fandromedocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fandromedocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fandromedocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Fandromedocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex","download_url":"https://codeload.github.com/vtex/andromedocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248852184,"owners_count":21171842,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["design-system","documentation","gatsby","hacktoberfest"],"created_at":"2024-11-27T20:25:33.328Z","updated_at":"2025-04-14T09:15:17.912Z","avatar_url":"https://github.com/vtex.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# andromedocs 🚀📝\n\n`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.\n\n## Usage\n\nThis 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.\n\n## Contributing\n\nRefer to our [contributing guidelines](./CONTRIBUTING.md).\n\n## Components\n\nThe `components` package consists of components that can come in handy for documenting a DS.\n\n### Running locally\n\nYou can run `yarn storybook:components` to execute Storybook locally and check out some examples of how the components can be used.\n\n### Component list\n\n#### Status Tag\n\nDisplays the current status of the component, usually stable, experimental, or deprecated, to indicate if it is safe to utilize it.\n\n#### Guidelines\n\nProvides orientation on how a component should (**Dos**) and should not (**Don'ts**) be used.\n\n## Gatsby Theme\n\nThe andromedocs Gatsby theme provides a framework to build documentation pages with the support of MDX (Markdown + JSX).\n\n### Running locally\n\nRun `yarn develop:theme` to run the andromedocs theme in development mode.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Fandromedocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex%2Fandromedocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Fandromedocs/lists"}