Follow https://sustainable-computing.io/ to see documentation
Requirements:
- Python 3.8
pip install -r requirements.txtmkdocs new [dir-name]- Create a new project.mkdocs serve- Start the live-reloading docs server.mkdocs build- Build the documentation site.mkdocs -h- Print help message and exit.
The website layout can be found in ./mkdocs.yml.
GitHub codespaces is a pre-configured, virtual, temporary and throwaway environment that you can use to build, modify and contribute to the Kepler docs. GitHub codespaces provides a generous free tier but always delete your environment after use to avoid bill shock.
- Fork this repo
- In your fork, click the green
Codebutton - Switch across to the Codespaces tab
- Click "Create codespace on main"
- A new tab will open and your environment will be built
- Once built, type
mkdocs serve - A box will appear informing you that the site is available on port
8000. Click the link to view the site - Make your changes as normal to the files within the
docs/folder. The preview site will live reload - When you're satisfied with your updates, commit them to your fork:
git add -A && git commit -sm "docs: a commit message here" && git push - Create a PR and you're done