https://github.com/grindjs/docs
Documentation for Grind
https://github.com/grindjs/docs
docs grind-framework grindjs
Last synced: 3 months ago
JSON representation
Documentation for Grind
- Host: GitHub
- URL: https://github.com/grindjs/docs
- Owner: grindjs
- Created: 2017-01-19T06:02:12.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2020-09-22T03:55:00.000Z (over 5 years ago)
- Last Synced: 2025-01-10T16:14:12.721Z (over 1 year ago)
- Topics: docs, grind-framework, grindjs
- Homepage: https://grind.rocks/docs
- Size: 184 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
README
# Grind Documentation
This is the main documentation for Grind and powers [grind.rocks/docs](https://grind.rocks/docs)
Good documentation is key for any framework and contributions are encouraged! The docs are built in markdown so you should be able to easily fork and edit.
If you’d prefer to edit locally an view them as you work, you can setup the [Grind site](https://github.com/grindjs/site):
```bash
git clone https://github.com/grindjs/site.git grind-site
cd grind-site/resources
git clone https://github.com/grindjs/docs.git && cd ..
yarn install
bin/cli watch
```
Once running, navigate to [localhost:3900/docs](http://localhost:3900/docs).