https://github.com/green-coding-solutions/documentation
Source files for the documentation which can be found under https://docs.green-coding.io
https://github.com/green-coding-solutions/documentation
Last synced: about 2 months ago
JSON representation
Source files for the documentation which can be found under https://docs.green-coding.io
- Host: GitHub
- URL: https://github.com/green-coding-solutions/documentation
- Owner: green-coding-solutions
- Created: 2022-06-18T11:16:18.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-05T09:28:36.000Z (3 months ago)
- Last Synced: 2026-03-05T13:51:40.833Z (3 months ago)
- Language: HTML
- Homepage: https://docs.green-coding.io
- Size: 2.62 MB
- Stars: 3
- Watchers: 2
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Documentation of the Green Metrics Tool
This is only the source.
Here is the [Live Version](https://docs.green-coding.io)
## Updating
The theme is a child-theme of [Doks](https://getdoks.org/docs/).
The main theme is referenced as node_module and thus updating is handled via npm.
Following files have been overloaded and should be checked if they are changed on an update:
- `assets/js/flexsearch.js` (commented out one line due to an Firefox-related issue)
- `/layouts/partials/*` (Removed integrity protection to run on Cloudflare CDN)
- `/layouts/index.headers` (Removed CSP netlify)
## Local build
```bash
npm install
npm run build
```
## Deploying to Cloudflare
- Framework preset: `hugo`
- Build command: `npm install && hugo`
- HUGO_VERSION: `0.99.0`
- NODE_VERSION: `NODE_VERSION`
## Measuring energy for build
If you want to measure the energy just use the `usage_scenario.yml` file inside
which will tell you how much Joules / kWh the build will cost.
You can find all the measurements on https://metrics.green-coding.io/ by searching
for the repository URL.
