Skip to content

Commit a01b0ed

Browse files
committed
clean up docs
1 parent e756f35 commit a01b0ed

File tree

137 files changed

+890
-63129
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

137 files changed

+890
-63129
lines changed

bunit.docs/docs/csharp-based-testing.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
This pages documents how to do Blazor/Razor component testing using just C#.
44

5-
Before you get started, make sure you have read the [Getting started](/docs/Getting-Started.html) page and in particular the [Basics of Blazor component testing](/docs/Basics-of-Blazor-component-testing.html) section. It wont take long, and it will ensure you get a good start at component testing.
5+
Before you get started, make sure you have read the [Getting started](/docs/getting-started.html) page and in particular the [Basics of Blazor component testing](/docs/basics-of-blazor-component-testing.html) section. It wont take long, and it will ensure you get a good start at component testing.
66

77
> **NOTE:** You are currently required to write your tests using the xUnit framework. If popular demand requires it, this library can be made test framework independent in the future.
88
9-
> **TIP:** Working with and asserting against the rendered component and its output is covered on the [Working with rendered components and fragments](/docs/Working-with-rendered-components-and-fragments.html) page.
9+
> **TIP:** Working with and asserting against the rendered component and its output is covered on the [Working with rendered components and fragments](/docs/working-with-rendered-components-and-fragments.html) page.
1010
1111
**Content:**
1212

@@ -18,10 +18,10 @@ Before you get started, make sure you have read the [Getting started](/docs/Gett
1818

1919
**Further reading:**
2020

21-
- [Working with rendered components and fragments](/docs/Working-with-rendered-components-and-fragments.html)
22-
- [Semantic HTML markup comparison](/docs/Semantic-HTML-markup-comparison.html)
23-
- [Mocking JsRuntime](/docs/Mocking-JsRuntime.html)
24-
- [C# test examples](/docs/CSharp-test-examples.html)
21+
- [Working with rendered components and fragments](/docs/working-with-rendered-components-and-fragments.html)
22+
- [Semantic HTML markup comparison](/docs/semantic-html-markup-comparison.html)
23+
- [Mocking JsRuntime](/docs/mocking-jsruntime.html)
24+
- [C# test examples](/docs/csharp-test-examples.html)
2525

2626
## Creating an new test class
2727

@@ -71,7 +71,7 @@ The `RenderComponent<TComponent>(params ComponentParameter[] parameters) : IRend
7171

7272
- `TComponent` is the type of component you want to render.
7373
- `ComponentParameter[] parameters` represents parameters that will be passed to the component during render.
74-
- `IRenderedComponent<TComponent>` is the representation of the rendered component. Working with the rendered component and its output is covered on the [Working with rendered components and fragments](/docs/Working-with-rendered-components-and-fragments.html) page.
74+
- `IRenderedComponent<TComponent>` is the representation of the rendered component. Working with the rendered component and its output is covered on the [Working with rendered components and fragments](/docs/working-with-rendered-components-and-fragments.html) page.
7575

7676
### Passing parameters to components during render
7777

@@ -166,7 +166,7 @@ This is done via the `ITestContext.Services` property. Once a component has been
166166

167167
If for example we want to render the with a dependency on an `IMyService`, we first have to call one of the `AddSingleton` methods on the service collection and register it. All the normal `AddSingleton` `ServiceCollection` overloads are available.
168168

169-
In the case if a `IJsRuntime` dependency, we can however use the built-in [Mocking JsRuntime](/docs/Mocking-JsRuntime.html). For example:
169+
In the case if a `IJsRuntime` dependency, we can however use the built-in [Mocking JsRuntime](/docs/mocking-jsruntime.html). For example:
170170

171171
```csharp
172172
public class ComponentTest : ComponentTestFixture // implements the ITestContext interface
@@ -187,12 +187,4 @@ public class ComponentTest : ComponentTestFixture // implements the ITestContext
187187
}
188188
```
189189

190-
See the page [Mocking JsRuntime](/docs/Mocking-JsRuntime.html) for more details mock.
191-
192-
## Further reading
193-
194-
To learn how to work with and assert against `IRenderedComponent`s visit the related pages:
195-
196-
- [Working with rendered components and fragments](/docs/Working-with-rendered-components-and-fragments.html)
197-
- [Semantic HTML markup comparison](/docs/Semantic-HTML-markup-comparison.html)
198-
- [Mocking JsRuntime](/docs/Mocking-JsRuntime.html)
190+
See the page [Mocking JsRuntime](/docs/mocking-jsruntime.html) for more details mock.

bunit.docs/docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Testing Blazor components is **_not_** the same as testing a regular class. It b
44

55
Thus, for first time Blazor component testers, the recommended reading is (5-10 minutes):
66

7-
- [Basics of Blazor component testing](/docs/Basics-of-Blazor-component-testing.html)
8-
- [Creating a new test project](/docs/Creating-a-new-test-project.html)
7+
- [Basics of Blazor component testing](/docs/basics-of-blazor-component-testing.html)
8+
- [Creating a new test project](/docs/creating-a-new-test-project.html)
99

1010
If you prefer a **video based tutorial**, check out:
1111

bunit.docs/docs/razor-based-testing.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
This pages documents how to do Blazor/Razor component testing from `.razor` files.
44

5-
Before you get started, make sure you have read the [Getting started](/docs/Getting-Started.html) page and in particular the [Basics of Blazor component testing](/docs/Basics-of-Blazor-component-testing.html) section. It wont take long, and it will ensure you get a good start at component testing.
5+
Before you get started, make sure you have read the [Getting started](/docs/getting-started.html) page and in particular the [Basics of Blazor component testing](/docs/basics-of-blazor-component-testing.html) section. It wont take long, and it will ensure you get a good start at component testing.
66

77
> **NOTE:** This feature is _EXPERIMENTAL_ and syntax and API will likely changed. Here are a few limitations to be aware of at the moment:
88
>
99
> - The xUnit test runner can detect and execute tests in Razor test components, but is not able to distinguish the individual `<Fixture>`'s from each other. They are all executed together, one at the time. The solution is planned, see the [related issue](https://github.com/egil/razor-components-testing-library/issues/4) for details.
10-
> - Go to the [Contribute](https://github.com/egil/razor-components-testing-library/wiki/Contribute) page for info on how to provide feedback and suggestions.
10+
> - Go to the [Contribute](/docs/contribute) page for info on how to provide feedback and suggestions.
1111
12-
> **TIP:** Working with and asserting against the rendered component and its output is covered on the [Working with rendered components and fragments](/docs/Working-with-rendered-components-and-fragments.html) page.
12+
> **TIP:** Working with and asserting against the rendered component and its output is covered on the [Working with rendered components and fragments](/docs/working-with-rendered-components-and-fragments.html) page.
1313
1414
**Content:**
1515

@@ -19,10 +19,10 @@ Before you get started, make sure you have read the [Getting started](/docs/Gett
1919

2020
**Further reading:**
2121

22-
- [Working with rendered components and fragments](/docs/Working-with-rendered-components-and-fragments.html)
23-
- [Semantic HTML markup comparison](/docs/Semantic-HTML-markup-comparison.html)
24-
- [Mocking JsRuntime](/docs/Mocking-JsRuntime.html)
25-
- [Razor test examples](/docs/Razor-test-examples.html)
22+
- [Working with rendered components and fragments](/docs/working-with-rendered-components-and-fragments.html)
23+
- [Semantic HTML markup comparison](/docs/semantic-html-markup-comparison.html)
24+
- [Mocking JsRuntime](/docs/mocking-jsruntime.html)
25+
- [Razor test examples](/docs/razor-test-examples.html)
2626

2727
## Creating a new Razor test component
2828

@@ -56,7 +56,7 @@ You will also need to import a few namespaces to make asserting and mocking poss
5656
@using Xunit
5757
```
5858

59-
> **NOTE:** The `_Imports.razor` has already been created for you if you are using the [Blazor test project template](/docs/Creating-a-new-test-project.html).
59+
> **NOTE:** The `_Imports.razor` has already been created for you if you are using the [Blazor test project template](/docs/creating-a-new-test-project.html).
6060
6161
## Defining tests/fixtures in test components
6262

bunit.docs/docs/working-with-rendered-components-and-fragments.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ This page is on the todo list.
44

55
To see examples of how to work with rendered components and fragments, go to the following pages:
66

7-
- [C# test examples](https://github.com/egil/razor-components-testing-library/wiki/C%23-test-examples)
8-
- [Razor test examples](https://github.com/egil/razor-components-testing-library/wiki/Razor-test-examples)
7+
- [C# test examples](/docs/csharp-test-examples.html)
8+
- [Razor test examples](/docs/razor-test-examples.html)

0 commit comments

Comments
 (0)