https://github.com/jenil/doction
Document your design system easily
https://github.com/jenil/doction
design-systems documentation
Last synced: 11 months ago
JSON representation
Document your design system easily
- Host: GitHub
- URL: https://github.com/jenil/doction
- Owner: jenil
- License: mit
- Created: 2018-03-03T21:01:26.000Z (over 8 years ago)
- Default Branch: gh-pages
- Last Pushed: 2024-01-18T15:44:41.000Z (over 2 years ago)
- Last Synced: 2025-04-15T06:12:34.236Z (about 1 year ago)
- Topics: design-systems, documentation
- Language: JavaScript
- Homepage: https://jenil.github.io/doction/
- Size: 193 KB
- Stars: 13
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Doction
---
Document your design system easily
Try it out, head to [the demo](https://jenil.github.io/doction/?storage=local) and click "Edit" on the top bar.
## Getting Started
Easiest way to get started at the moment is by forking this repo and edit the `_config.yml` to change the name and save it. Your documentation website should then be live on GitHub Pages at `.github.io/doction`
## Run locally
Follow the [installation instruction](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/) for Github Pages, then run:
```
bundle exec jekyll serve --incremental
```