Skip to content

Commit ae6c002

Browse files
Use the new theme for docs
1 parent 2f436f4 commit ae6c002

File tree

18 files changed

+160
-172
lines changed

18 files changed

+160
-172
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ jobs:
5454
uses: peaceiris/actions-gh-pages@v4
5555
with:
5656
github_token: ${{secrets.GITHUB_TOKEN}}
57-
publish_dir: docs-dest/
57+
publish_dir: docs/_site/
5858
user_name: "Tolik Pylypchuk"
5959
user_email: "[email protected]"
6060
commit_message: "Deploy docs to GitHub Pages"

Matchmaker.slnx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<File Path="docs/favicon.ico" />
66
<File Path="docs/index.md" />
77
<File Path="docs/logo.svg" />
8+
<File Path="docs/template/public/main.css" />
9+
<File Path="docs/template/public/main.js" />
810
<File Path="docs/toc.yml" />
911
</Folder>
1012
<Folder Name="/docs/api/">
@@ -14,7 +16,6 @@
1416
<Folder Name="/docs/articles/">
1517
<File Path="docs/articles/async.md" />
1618
<File Path="docs/articles/expressions.md" />
17-
<File Path="docs/articles/intro.md" />
1819
<File Path="docs/articles/migration.md" />
1920
<File Path="docs/articles/nullable.md" />
2021
<File Path="docs/articles/patterns.md" />

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
log.txt
2+
_site/

docs/api/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# Matchmaker API
22

3-
Use the sidebar to navigate the API documentation.
3+
This section contains API docs for the [Matchmaker](https://www.nuget.org/packages/Matchmaker) package. Use the sidebar
4+
to navigate the API documentation.

docs/articles/async.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,3 @@ Static async match expressions are also available. Use the `AsyncMatch.CreateSta
5050
like normal match expressions. The methods accept an action on either `AsyncMatchBuilder<TInput, TOutput>` or
5151
`AsyncMatchBuilder<TInput>`. Static match expressions are globally cached and the caching process is thread-safe.
5252
Caches can be cleared with the `ClearCache` methods in `AsyncMatch`.
53-
54-
Next article: [Discriminated unions](unions.md)

docs/articles/expressions.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,5 +179,3 @@ The `Match` class also contains the `ClearCache` methods which clear a global ca
179179
per type (so `Match<int, int>` uses a different cache than `Match<int, string>`) so `ClearCache` only clears one
180180
cache. Clearing the cache will force all static match expressions of that type to be reinitialized. This process is
181181
not thread-safe as well.
182-
183-
Next article: [Asynchronous pattern matching](async.md)

docs/articles/intro.md

Lines changed: 0 additions & 103 deletions
This file was deleted.

docs/articles/migration.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,5 +67,3 @@ of successful cases, you can call `Count()` on the result of the match. Or you c
6767
`Matchmaker.Linq` if you just want to execute it. Since matching with fall-though is lazy, it doesn't have modes
6868
of execution - it's just non-strict. The library cannot decide to throw an exception if there are no successful cases
6969
because the library doesn't decide when to execute the expression.
70-
71-
Next article: [Why this library was written](why.md)

docs/articles/nullable.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,3 @@ When using this library with NRTs enabled, remember two things:
2727

2828
- `MatchResult<T>` may contain `null` and so patterns can return `null` as their results as well
2929
- Match expressions' results may be `null`
30-
31-
Next article: [Migration guide](migration.md)

docs/articles/patterns.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,5 +117,3 @@ means that the pattern doesn't have a description.
117117
You can also implement the `IPattern<TInput, TMatchResult>` interface directly. But there is no reason to do that
118118
instead of extending the `Pattern<TInput, TMatchResult>` class unless your class already extends another class. But
119119
in that case making your class a pattern will break the single responsibility principle. So, don't do that.
120-
121-
Next article: [Match expressions](expressions.md)

0 commit comments

Comments
 (0)