This repository contains the main documentation files for the GLAM Workbench and is used to build the site at: glam-workbench.net.
I also use this repository to bring together issues and discussions relating to the GLAM Workbench in general – feel free to contribute!
Here's a complete list of GLAM Workbench repositories.
For minor edits and corrections:
If you're making major changes, such as adding a new section, you'll want to set up your own local version of the documentation for editing and testing:
site
directory: cd glam-workbench.github.io/site
pip-tools
: pip install pip tools
pip-sync
mkdocs serve
. The site will be available at http://127.0.0.1:8000/.docs
directory. See MkDocs and Material for MkDocs documentation for more information.Any changes to markdown files in the docs
directory should trigger a rebuild and reload of the site. If you make changes to templates, or to the mkdocs.yml
config file, you'll probably need to stop and restart the server. Once you've finished you can git push
the changes back to your fork, and create a pull request.
Note that the main site is built using Material for MkDocs Insiders which is a private repository that can only be accessed through sponsorship. The instructions above will install the public version of Material for MkDocs. The site will look and act much the same, but some extended features, such as search and tagging won't be available.
Tim Sherratt, GLAM Workbench, 2021, https://doi.org/10.5281/zenodo.5603059
This work is licensed under a Creative Commons Attribution 4.0 International License.