The website that presents Open Terms Archive to the general public.
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/opentermsarchive.org
cd docs
npm install
hugo
hugo
The website will be built in the public
directory.
For development purposes:
npm run start:dev
To lint the Markdown files use the following command:
npm run lint:markdown
To apply automatic corrections use the following command:
npm run lint:markdown -- --fix
To lint the CSS files use the following command:
npm run lint:css
To apply automatic corrections use the following command:
npm run lint:css -- --fix
To lint the JavaScript files use the following command:
npm run lint:js
To automatically fix, where possible, problems reported:
npm run lint:js -- --fix
To lint the HTML files use the following command:
npm run lint:html
To automatically fix, where possible, problems reported:
npm run lint:html -- --fix
Run the entire test set
npm run test
npm run test:links
npm run test:html
Note that because of CloudFlare protection, tests on external links are not run in CI so as not to block on 503 errors.
npm run test:e2e
The 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.
See our contributing guide.
Nicolas Dupont 💻 🚇 |
Matti Schneider 💻 📆 |
Clément Biron 💻 🎨 |
The code for this software is distributed under the European Union Public Licence (EUPL) v1.2. Contact the author if you have any specific need or question regarding licensing.