Skip to content

Commit d6c569a

Browse files
committed
docs update
1 parent 7684b4a commit d6c569a

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ var diffs = DiffBuilder
2424

2525
Read more about the available options on the [Diffing Options/Strategies](/docs/Strategies.md) page.
2626

27+
# Documentation
28+
- [Diffing Options/Strategies](/docs/Strategies.md)
29+
- [Creating custom diffing options/strategies](/docs/CustomStrategies.md)
30+
- [Difference engine internals](/docs/DifferenceEngineInternals.md)
31+
2732
## Acknowledgments
2833
Big thanks to [Florian Rappl](https://github.com/FlorianRappl) from the AngleSharp team for providing ideas, input and sample code for working with AngleSharp.
2934

docs/DiffingEngineInternals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Difference engine details
1+
# Difference engine internals
22
The heart of the library is the `HtmlDifferenceEngine` class, which goes through the steps illustrated in the activity diagram below to determine if the control nodes is the same as the test nodes.
33

44
The `HtmlDifferenceEngine` class depends on three _strategies_, the `IFilterStrategy`, `IMatcherStrategy`, and `ICompareStrategy` types. These are used in the highlighted activities in the diagram. With those, we can control what nodes and attributes take part in the comparison (filter strategy), how control and test nodes and attributes are matched up for comparison (matching strategy), and finally, how nodes and attributes are determined to be same or different (compare strategy).

docs/Strategies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ To configure/override whitespace rules on a specific subtree in the comparison,
263263
**NOTE:** It is on the issues list to deal with whitespace properly inside `<style>` and `<script>`-tags, e.g. inside strings.
264264

265265
#### Perform case-_insensitve_ text comparison
266-
To compare the text in two text nodes to each other using a case-insensitive comparison, call the ``WithTextComparer(WhitespaceOption, ignoreCase: true)` method on a `DiffBuilder` instance, e.g.:
266+
To compare the text in two text nodes to each other using a case-insensitive comparison, call the `WithTextComparer(WhitespaceOption, ignoreCase: true)` method on a `DiffBuilder` instance, e.g.:
267267

268268
```csharp
269269
var diffs = DiffBuilder

0 commit comments

Comments
 (0)