Add checkdocs workflow.
This commit is contained in:
parent
c7a719ab82
commit
e9dbdc46fc
17 changed files with 88 additions and 59 deletions
35
.github/workflows/checkdocs.yml
vendored
Normal file
35
.github/workflows/checkdocs.yml
vendored
Normal file
|
@ -0,0 +1,35 @@
|
|||
name: Check Docs
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- develop
|
||||
paths:
|
||||
- 'markdown/**'
|
||||
pull_request:
|
||||
branches:
|
||||
- develop
|
||||
paths:
|
||||
- 'markdown/**'
|
||||
|
||||
jobs:
|
||||
test:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [14.x]
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v2
|
||||
- name: Setup Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
- name: Install Remark
|
||||
run: npm install remark-cli remark-frontmatter remark-lint-emphasis-marker remark-lint-list-item-indent remark-preset-lint-consistent remark-preset-lint-recommended
|
||||
- name: Check Docs
|
||||
run: npm run checkdocs
|
||||
|
|
@ -16,7 +16,7 @@ Your snapped percentage option should be a plain object with these properties:
|
|||
- `min` : The minimum percentage that's allowed
|
||||
- `max` : The maximum percentage that's allowed
|
||||
- `snap`: Holds the snap configuration (see [Snap configuration](#))
|
||||
- `toAbs`: a method returning the **millimeter value** of the option ([see `toAbs()`](toabs))
|
||||
- `toAbs`: a method returning the **millimeter value** of the option ([see `toAbs()`][toabs])
|
||||
- `hide` <small>(optional)</small> : A method to [control the optional display of the option][hide]
|
||||
|
||||
## Snap configuration
|
||||
|
@ -235,8 +235,6 @@ to clarify the difference.
|
|||
|
||||
</Note>
|
||||
|
||||
[fromabs]: /reference/api/config/options/pct/fromabs
|
||||
|
||||
[toabs]: /reference/api/config/options/pct/toabs
|
||||
|
||||
[pct]: /reference/api/config/options/pct
|
||||
|
|
|
@ -2,7 +2,9 @@
|
|||
title: intersects()
|
||||
---
|
||||
|
||||
```
|
||||
array|false path.intersects(Path path)
|
||||
```
|
||||
|
||||
Returns the Point object(s) where the path intersects with a path you pass it.
|
||||
|
||||
|
|
|
@ -65,9 +65,11 @@ git config --global user.name "<your display name for your git account>"
|
|||
|
||||
FreeSewing uses .editorconfig files to enforce a consistent style for the project. VSCode relies on extensions to provide this functionality and due to a design shortcoming it does not respect certain editorconfig options which will break certain files in the freesewing project ([see vscode/65663 for details](https://github.com/microsoft/vscode/issues/65663)). If you use this editor please ensure that your settings.json file is configured to not trim trailing whitespace from markdown files. The following snippet can be added to your settings.json file to add an exemption for this file type:
|
||||
|
||||
```json
|
||||
"[markdown]": {
|
||||
"files.trimTrailingWhitespace": false
|
||||
},
|
||||
```
|
||||
|
||||
</Note>
|
||||
|
||||
|
|
|
@ -5,8 +5,8 @@ order: 300
|
|||
|
||||
Zum Erstellen von maßgeschneiderten Schnittmustern benötigen wir Maße. Jedes Mal danach zu fragen wäre ziemlich umständlich, weshalb wir sie für dich speichern.
|
||||
|
||||
Wir brauchen einen Ort, an dem wir sie speichern können, und dieser *Ort* ist dein Account. Deine Accountdaten werden im Backend gespeichert, unter Einhaltung [unserer Datenschutzerklärung][2], und natürlich werden dabei [deine Rechte][2] respektiert.
|
||||
|
||||
[2]: /docs/various/rights/
|
||||
Wir brauchen einen Ort, an dem wir sie speichern können, und dieser *Ort* ist dein Account. Deine Accountdaten werden im Backend gespeichert, unter Einhaltung [unserer Datenschutzerklärung][1], und natürlich werden dabei [deine Rechte][2] respektiert.
|
||||
|
||||
[1]: /docs/various/privacy/
|
||||
|
||||
[2]: /docs/various/rights/
|
||||
|
|
|
@ -7,7 +7,7 @@ To generate made-to-measure sewing patterns, we need measurements.
|
|||
Asking for them every time would be rather tedious, so we store them for you.
|
||||
|
||||
We need a place to store them, and that *place* is your account.
|
||||
Your account data is stored on our backend, subject to [our privacy notice][2],
|
||||
Your account data is stored on our backend, subject to [our privacy notice][1],
|
||||
and with respect for [your rights][2].
|
||||
|
||||
[1]: /docs/various/privacy/
|
||||
|
|
|
@ -5,8 +5,8 @@ order: 300
|
|||
|
||||
Para generar patrones de costura hechos a medida, necesitamos mediciones. Preguntarlos cada vez sería más tedioso, así que los almacenamos para usted.
|
||||
|
||||
Necesitamos un lugar para almacenarlos, y ese *lugar* es tu cuenta. Your account data is stored on our backend, subject to [our privacy notice][2], and with respect for [your rights][2].
|
||||
|
||||
[2]: /docs/various/rights/
|
||||
Necesitamos un lugar para almacenarlos, y ese *lugar* es tu cuenta. Your account data is stored on our backend, subject to [our privacy notice][1], and with respect for [your rights][2].
|
||||
|
||||
[1]: /docs/various/privacy/
|
||||
|
||||
[2]: /docs/various/rights/
|
||||
|
|
|
@ -5,8 +5,8 @@ order: 300
|
|||
|
||||
Pour créer des patrons sur mesure, nous avons besoin de vos mesures. Demander à chaque fois serait plutôt fastidieux, alors nous les stockons pour vous.
|
||||
|
||||
Nous avons besoin d'un endroit pour les stocker, et cet *endroit* est votre compte. Les données de votre compte sont stockées dans nos serveurs, dans le respect de [notre politique de confidentialité][2], et dans le respect de [vos droits][2].
|
||||
|
||||
[2]: /docs/various/rights/
|
||||
Nous avons besoin d'un endroit pour les stocker, et cet *endroit* est votre compte. Les données de votre compte sont stockées dans nos serveurs, dans le respect de [notre politique de confidentialité][1], et dans le respect de [vos droits][2].
|
||||
|
||||
[1]: /docs/various/privacy/
|
||||
|
||||
[2]: /docs/various/rights/
|
||||
|
|
|
@ -5,8 +5,8 @@ order: 300
|
|||
|
||||
Om naaipatronen op maat te genereren, hebben we metingen nodig. Elke keer om ze vragen zou nogal saai zijn, dus we slaan ze voor je op.
|
||||
|
||||
We hebben een plaats nodig om ze op te slaan, en die *plaats* is uw account. Uw accountgegevens worden opgeslagen in onze backend, onder [onze privacyverklaring][2], en met respect voor [uw rechten][2].
|
||||
|
||||
[2]: /docs/various/rights/
|
||||
We hebben een plaats nodig om ze op te slaan, en die *plaats* is uw account. Uw accountgegevens worden opgeslagen in onze backend, onder [onze privacyverklaring][1], en met respect voor [uw rechten][2].
|
||||
|
||||
[1]: /docs/various/privacy/
|
||||
|
||||
[2]: /docs/various/rights/
|
||||
|
|
|
@ -7,5 +7,3 @@
|
|||
[Schau dir zum Loslegen unseren Leitfaden an][1]
|
||||
|
||||
[1]: /docs/guide/
|
||||
|
||||
[1]: /docs/guide/
|
||||
|
|
|
@ -7,5 +7,3 @@
|
|||
[Revisa nuestra guía de inicio][1]
|
||||
|
||||
[1]: /docs/guide/
|
||||
|
||||
[1]: /docs/guide/
|
||||
|
|
|
@ -7,5 +7,3 @@
|
|||
[Consultez notre guide de démarrage][1]
|
||||
|
||||
[1]: /docs/guide/
|
||||
|
||||
[1]: /docs/guide/
|
||||
|
|
|
@ -7,5 +7,3 @@
|
|||
[Bekijk onze startgids][1]
|
||||
|
||||
[1]: /docs/guide/
|
||||
|
||||
[1]: /docs/guide/
|
||||
|
|
|
@ -30,8 +30,8 @@
|
|||
"contributors:generate": "all-contributors generate",
|
||||
"famadd": "all-contributors add",
|
||||
"famgen": "all-contributors generate",
|
||||
"checkdocs": "remark ./markdown/ --quiet --frail",
|
||||
"fixdocs": "remark ./markdown/ --quiet --frail --output"
|
||||
"checkdocs": "remark markdown --use remark-preset-lint-consistent --use remark-preset-lint-recommended --quiet --frail",
|
||||
"fixdocs": "remark markdown --use remark-preset-lint-consistent --use remark-preset-lint-recommended --output"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue