https://github.com/respoke/docs
https://github.com/respoke/docs
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/respoke/docs
- Owner: respoke
- License: mit
- Created: 2014-11-19T16:57:42.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-06-02T15:17:58.000Z (about 10 years ago)
- Last Synced: 2025-03-25T08:38:16.798Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://docs.respoke.io
- Size: 10.4 MB
- Stars: 5
- Watchers: 8
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Documentation site for Respoke.io
https://docs.respoke.io
## Working on the docs
```bash
git clone https://github.com/respoke/docs respoke-docs
cd respoke-docs
npm install
npm start
```
The first time you run it, there is a bug where you have to kill it and restart `npm start`. Then it will work correctly. We will fix that soon.
The site is hosted locally at http://localhost:2003/
## Co-development of Respoke Styles
Branding and styles are stored as an npm package (unpublished) at https://github.com/respoke/style for reuse.
You can check out the styles and develop them in tandem with the docs using `npm link`.
*Example*
```bash
git clone https://github.com/respoke/docs respoke-docs
cd respoke-docs
npm install
cd ../
git clone https://github.com/respoke/style respoke-style
cd respoke-style
npm install
npm link
cd ../respoke-docs
npm link respoke-style
npm start
```
## License
This source code is licensed under The MIT License found in the
[LICENSE](LICENSE) file in the root directory of this source tree.