Open Terms Archive documentation.
Pages and sections are ordered on the “end user” to “core team member” spectrum: the more up a page is in the menu, the more it is targeted at consumer end users, the more low it is the more it is targeted at committed contributors.
This website is built using Hugo, a static website editor, and uses Node.js.
To build it, install Hugo (>= v0.114.0) and Node.js, and then:
git clone https://github.com/OpenTermsArchive/docs
cd docs
npm install
hugohugoThe website will be built in the public directory.
For development purposes:
npm run start:devTo lint the Markdown files use the following command:
npm run lint:markdownTo apply automatic corrections use the following command:
npm run lint:markdown -- --fixTo lint the CSS files use the following command:
npm run lint:cssTo apply automatic corrections use the following command:
npm run lint:css -- --fixTo lint the JavaScript files use the following command:
npm run lint:jsTo automatically fix, where possible, problems reported:
npm run lint:js -- --fixBuild the site
hugo --minifyand run
npm run test:linksThe main branch is used on production and automatically deployed through GitHub pages. Refer to the configuration file .github/workflows/gh-pages.yml.
For each pull request, a preview is automatically deployed through Netlify and a comment on the GitHub pull request display the necessary information, such as the preview URL. The configuration can be found in netlify.toml file.
This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
This means you are free to share (copy and redistribute the material in any medium or format) and adapt (remix, transform, and build upon the material for any purpose, even commercially) as long as you credit “Open Terms Archive contributors” as original author, provide a link to the license, and indicate which changes were made; and distribute your contributions under the same license as the original.