This repository contains draft versions of the terms and conditions for the augment.eco service, operated by Augment Mobility Ab.
Important! The legally binding terms and conditions are available at https://augment.eco/en/contract-of-service/. The files in this repository are for reference and in-progress work only — they are not legally binding.
- Choose the file you want to edit (e.g. escoot/fi-fi/augment-sopimusehdot-fi-fi.md).
- Use a markdown editor of your choice, such as Dillinger or StackEdit, to make changes. Be sure to check the Special Markup section below for handling specific formatting requirements.
- Submit the updated file to the repository once your edits are complete.
The following patterns are used in markdown files for specific formatting:
- Hard page break: To force content to the next page in a PDF, use
<div class="page"></div>. - Full-width underline: For a full-width underline, use
<div class="underline"></div>.
GitHub Actions will automatically generate and commit a PDF version for pull requests involving changes to markdown files. Additionally, a preview of the changes will be made available as a comment on the pull request.
If we want to preview the PDF locally before submitting a pull request, to check our page breaks, for example, we can do so by running the following command:
npm run generate "<path-to-file>.md" "test-preview.pdf" trueIt will generate the PDF file from the specified Markdown file. Do not upload this test file.
All markdown files are being linted while running Continous Integration (CI). The generate of PDFs will fail, in case linting errors are found. The linting is done using markdownlint. The configuration can be found in the .markdownlint-cli2.jsonc file.
You can also lint the markdown files locally by running the following command:
npm run lintAlso, in the case you are using VSCode, you can install the markdownlint extension to lint the markdown files while editing.