-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #851 from unoplatform/dev/agzi/FixMarkdownDocIssues
docs: Enable markdown linting and spell checking with related fixes
- Loading branch information
Showing
53 changed files
with
829 additions
and
340 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,57 @@ | ||
| trigger: | ||
| branches: | ||
| include: | ||
| - main | ||
| - release/stable/* | ||
| - feature/* | ||
|
|
||
| jobs: | ||
| - template: .vsts-ci-packages.yml | ||
| parameters: | ||
| jobName: Packages | ||
| pr: | ||
| branches: | ||
| include: | ||
| - main | ||
| - release/stable/* | ||
| - feature/* | ||
|
|
||
| - template: .vsts-ci-linux.yml | ||
| parameters: | ||
| jobName: Linux_Tests | ||
| linux_container: unoplatform/wasm-build:3.0 | ||
| stages: | ||
| - stage: Determine_Changes | ||
| displayName: Determine Changes | ||
| jobs: | ||
| - template: build/ci/stage-determine-changes.yml | ||
|
|
||
| - template: .vsts-ci-windows-tests.yml | ||
| parameters: | ||
| jobName: Windows_Tests | ||
| linux_container: unoplatform/wasm-build:3.0 | ||
| - stage: Docs_Validations | ||
| displayName: Docs Validations | ||
| dependsOn: Determine_Changes | ||
| # Trigger this stage when docs files are changed | ||
| condition: or(eq(dependencies.Determine_Changes.outputs['evaluate_changes.DetermineChanges.docsOnly'], 'true'), eq(dependencies.Determine_Changes.outputs['evaluate_changes.DetermineChanges.mixedChanges'], 'true')) | ||
| jobs: | ||
| - template: build/ci/stage-docs-validations.yml | ||
|
|
||
| - template: .vsts-ci-macos.yml | ||
| parameters: | ||
| jobName: macOS_Tests | ||
| vmImage: macOS-12 | ||
| - stage: Packages | ||
| displayName: Packages | ||
| dependsOn: Determine_Changes | ||
| # Don't trigger this stage if only docs files are changed | ||
| condition: ne(dependencies.Determine_Changes.outputs['evaluate_changes.DetermineChanges.docsOnly'], 'true') | ||
| jobs: | ||
| - template: build/ci/stage-build-packages.yml | ||
| parameters: | ||
| jobName: Packages | ||
|
|
||
| - template: .vsts-ci-wsl-tests.yml | ||
| - stage: Build_Tests | ||
| displayName: Build Tests | ||
| dependsOn: Determine_Changes | ||
| # Don't trigger this stage if only docs files are changed | ||
| condition: ne(dependencies.Determine_Changes.outputs['evaluate_changes.DetermineChanges.docsOnly'], 'true') | ||
| jobs: | ||
| - template: build/ci/stage-build-linux-tests.yml | ||
| parameters: | ||
| jobName: Linux_Tests | ||
| linux_container: unoplatform/wasm-build:3.0 | ||
| - template: build/ci/stage-build-windows-tests.yml | ||
| parameters: | ||
| jobName: Windows_Tests | ||
| linux_container: unoplatform/wasm-build:3.0 | ||
| - template: build/ci/stage-build-macos-tests.yml | ||
| parameters: | ||
| jobName: macOS_Tests | ||
| vmImage: macOS-12 | ||
| - template: build/ci/stage-build-wsl-tests.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "default": true, | ||
| "line-length": false, | ||
| "commands-show-output": false, | ||
| "no-bare-urls": false, | ||
| "no-inline-html": false, | ||
| "no-duplicate-heading": false, | ||
| "MD051": false | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
| { | ||
| "version": "0.2", | ||
| "language": "en", | ||
| "words": [ | ||
| "Avalonia", | ||
| "ambiently", | ||
| "binlog", | ||
| "Blazor", | ||
| "blockquotes", | ||
| "Bootstrapper", | ||
| "brotli", | ||
| "browsersync", | ||
| "bytecode", | ||
| "Callout", | ||
| "chatops", | ||
| "codebases", | ||
| "Codespace", | ||
| "Codespaces", | ||
| "Contoso", | ||
| "Cupertino", | ||
| "customizability", | ||
| "databinding", | ||
| "datacontext", | ||
| "datagrid", | ||
| "devs", | ||
| "Dismissable", | ||
| "Docfx", | ||
| "ellipsize", | ||
| "Expando", | ||
| "flyouts", | ||
| "Framebuffer", | ||
| "Gamepad", | ||
| "gamepads", | ||
| "Geolocation", | ||
| "globbing", | ||
| "Gyrometer", | ||
| "Hanja", | ||
| "hectopascals", | ||
| "Inlines", | ||
| "keychain", | ||
| "laggy", | ||
| "layouter", | ||
| "layouting", | ||
| "Listview", | ||
| "LLRM", | ||
| "mergeable", | ||
| "MSAL", | ||
| "msbuild", | ||
| "MVUX", | ||
| "MVVM", | ||
| "NETSDK", | ||
| "netstandard", | ||
| "oidc", | ||
| "Omnisharp", | ||
| "overscroll", | ||
| "Packt", | ||
| "parameterless", | ||
| "pickable", | ||
| "Pluralsight", | ||
| "POSIX", | ||
| "reentrantly", | ||
| "Resizetizer", | ||
| "resw", | ||
| "roadmap", | ||
| "sandboxed", | ||
| "Segoe", | ||
| "Silverlight", | ||
| "Skia", | ||
| "skiasharp", | ||
| "Storyboarded", | ||
| "struct", | ||
| "Syncfusion", | ||
| "templatable", | ||
| "templating", | ||
| "timespan", | ||
| "Tizen", | ||
| "TLDR", | ||
| "toolkits", | ||
| "triaging", | ||
| "UI's", | ||
| "unmanaged", | ||
| "Uno's", | ||
| "unoplatform", | ||
| "UWP's", | ||
| "VSIX", | ||
| "walkthrough", | ||
| "WEBASSEMBLY", | ||
| "Haptics", | ||
| "subfolders", | ||
| "interoperating", | ||
| "bitcode", | ||
| "subresource", | ||
| "SIMD" | ||
| ], | ||
| "ignoreWords": [ | ||
| "ADAL", | ||
| "addin", | ||
| "AEHD", | ||
| "appsettings", | ||
| "Authenticode", | ||
| "automagically", | ||
| "Divio's", | ||
| "emcc", | ||
| "emscripten", | ||
| "Findlay", | ||
| "Flatpickr", | ||
| "Giesel", | ||
| "GNSS", | ||
| "GPIO", | ||
| "Grigorik", | ||
| "hdpi", | ||
| "Headered", | ||
| "Hoefling", | ||
| "HRESULT", | ||
| "Icaza", | ||
| "IDBFS", | ||
| "Ilya", | ||
| "Infragistics", | ||
| "jonathanpeppers's", | ||
| "Krueger", | ||
| "libgtk", | ||
| "Liu's", | ||
| "Logpoints", | ||
| "macios", | ||
| "Matteo", | ||
| "McCaffrey", | ||
| "mdpi", | ||
| "Mergify", | ||
| "mlaunch", | ||
| "muxc", | ||
| "netstd", | ||
| "nventive", | ||
| "odel", | ||
| "Onoh", | ||
| "pdate", | ||
| "Ronica", | ||
| "Serilog", | ||
| "Singh", | ||
| "slnf", | ||
| "Stetho", | ||
| "Talkin", | ||
| "UADO", | ||
| "Udemy", | ||
| "UNOB", | ||
| "unpackaged", | ||
| "winappsdk", | ||
| "winui", | ||
| "xhdpi", | ||
| "xxhdpi", | ||
| "xxxhdpi", | ||
| "Yowza", | ||
| "wslpath", | ||
| "httprequestmessage", | ||
| "praeclarum's" | ||
| ], | ||
| "patterns": [ | ||
| { | ||
| "name": "Markdown uid", | ||
| "pattern": "^(?=uid:).*$", | ||
| "description": "" | ||
| }, | ||
| { | ||
| "name": "Markdown links", | ||
| "pattern": "\\((.*)\\)", | ||
| "description": "" | ||
| }, | ||
| { | ||
| "name": "Markdown code blocks", | ||
| "pattern": "/^(\\s*`{3,}).*[\\s\\S]*?^\\1/gmx", | ||
| "description": "Taken from the cSpell example at https://cspell.org/configuration/patterns/#verbose-regular-expressions" | ||
| }, | ||
| { | ||
| "name": "Inline code blocks", | ||
| "pattern": "\\`([^\\`\\r\\n]+?)\\`", | ||
| "description": "https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex" | ||
| }, | ||
| { | ||
| "name": "Link contents", | ||
| "pattern": "\\<a(.*)\\>", | ||
| "description": "" | ||
| }, | ||
| { | ||
| "name": "Snippet references", | ||
| "pattern": "-- snippet:(.*)", | ||
| "description": "" | ||
| }, | ||
| { | ||
| "name": "Snippet references 2", | ||
| "pattern": "\\<\\[sample:(.*)", | ||
| "description": "another kind of snippet reference" | ||
| }, | ||
| { | ||
| "name": "Multi-line code blocks", | ||
| "pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm" | ||
| } | ||
| ], | ||
| "ignoreRegExpList": [ | ||
| "Markdown uid", | ||
| "Markdown links", | ||
| "Markdown code blocks", | ||
| "Inline code blocks", | ||
| "Link contents", | ||
| "Snippet references", | ||
| "Snippet references 2", | ||
| "Multi-line code blocks" | ||
| ], | ||
| "ignorePaths": [ | ||
| "../doc/index.md" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,8 +18,8 @@ jobs: | |
| version: 8.0.100 | ||
| includePreviewVersions: true | ||
|
|
||
| - template: build/ci/gitversion.yml | ||
| - template: build/ci/dotnet-install.yml | ||
| - template: gitversion.yml | ||
| - template: dotnet-install.yml | ||
|
|
||
| - bash: | | ||
| npm install -g [email protected] | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Oops, something went wrong.