The official Graphite Design System documentation, built with Eleventy.
Make sure you are using Node v16 (with npm v8). If you use nvm, you can run nvm use.
Run the following command on your local environment:
git clone https://github.com/paqtcom/graphite-design-system-site graphite-design-system-site
cd graphite-design-system-site
npm installThen, you can run locally in development mode with live reload:
npm run devOpen http://localhost:8080 with your favorite browser.
To update to the latest Graphite release use this tool to generate the correct integrity hash (but make sure you use type="module" for the script tag). Check the MDN docs for more info about this.
Note: don't forget to change the version number in the the top right of the site.
You can see the results locally in production mode with:
npm run serveThe master branch is automatically deployed to Netlify on https://graphitedesignsystem.com.
Plus, you can automatically preview PR's on Netlify.
We used this starter project.
MIT License
Copyright (c) 2020 Rem W.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
The layout is based on or inspired by Nuxt Content.
MIT License
Copyright (c) 2020 Nuxt.js with the contributions of:
- Sebastien Chopin (NuxtJS Company)
- Alexandre Chopin (NuxtJS Company)
- Benjamin Canac (NuxtJS Company)
- Sergey Bedritsky (NuxtJS Company)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Some documentation is based on or inspired by the Ionic Framework.
Some documentation is based on or inspired by Shoelace.
Some documentation is based on or inspired by the Spectrum Design System.
Some documentation is based on or inspired by the Carbon Design System.
Some documentation is based on or inspired by the Polaris Design System.