Common Knowledge handbook
We're Common Knowledge, a worker co-op. We use technology to help movements build power, and organise non-hierarchically and as openly as we can.
This is our handbook, published at handbook.commonknowledge.coop. It covers who we are, how we make decisions and work together, how we run projects with collaborators, and the policies we've agreed as members. A good place to start is our vision, mission and values.
Technical details
This uses Honkit to build the handbook.
The index file SUMMARY.md is auto-generated based on the folder structure of the repo. This functionality is configured in book.json, and relies on a plugin to work - visit the plugin homepage to read the docs on how to name files and folders.
Local development
- Check out the repository
- Run
npm installwhen inside the repository directory - Run
npm run spellcheck. This will report any spelling errors — fix them in your editor (the VS Code cspell extension provides inline suggestions) - Run
npm run buildbefore you commit changes - this will rebuildSUMMARY.mdto incorporate any changes you make to (a) filenames (b) folder names and (c) the relative locations of files and folders. - Run
npm run linksto check links between pages. This needs lychee installed (brew install lychee). The same check runs on every pull request and blocks deploys if a link is broken. Links to other sites are checked weekly, and any broken ones are listed in a GitHub issue.