Skip to content

Commit

Permalink
chore: update docs (#1101)
Browse files Browse the repository at this point in the history
Signed-off-by: Dave Skender <[email protected]>
  • Loading branch information
DaveSkender authored Oct 25, 2023
1 parent 6fd828a commit 6c2b310
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 17 deletions.
6 changes: 3 additions & 3 deletions docs/_includes/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
All docs are open source. See something that's<br />wrong or unclear? Submit a pull request.
</div>
<div>
<a class="btn" href="{{ site.github.repository_url }}/edit/main/docs/{{ page.relative_path }}" target="_blank" rel="noopener">
<a href="{{ site.github.repository_url }}/edit/main/docs/{{ page.relative_path }}" class="btn">
Edit this page
</a>
</div>
<div>Or,
<a href="{{site.baseurl}}/contributing/#content" target="_blank" rel="noopener">
<a href="{{site.baseurl}}/contributing/#content">
learn how to contribute
</a>
</div>
</div>
</footer>
</footer>
3 changes: 2 additions & 1 deletion docs/_includes/head-style.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@
}

.btn {
text-align: center;
display: inline-block;
margin: 0;
margin-left: 1rem;
Expand Down Expand Up @@ -314,4 +315,4 @@
padding-bottom: 0.7rem;
}
}
</style>
</style>
7 changes: 4 additions & 3 deletions docs/_includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@
<div class="btn-container">
<a href="{{site.baseurl}}/indicators/" class="btn">Indicators</a>
<a href="{{site.baseurl}}/guide/" class="btn">Guide</a>
<a href="https://www.nuget.org/packages/Skender.Stock.Indicators" class="btn">NuGet<span class="not-mobile">
Package</span></a>
<a href="{{site.github.repository_url}}" class="btn not-mobile"><span class="not-medium">View on </span>GitHub</a>
<a rel="noopener nofollow" target="_blank" href="https://www.nuget.org/packages/Skender.Stock.Indicators"
class="btn">NuGet<span class="not-mobile">Package</span></a>
<a rel="noopener nofollow" target="_blank" href="{{site.github.repository_url}}"
class="btn not-mobile"><span class="not-medium">View on </span>GitHub</a>
</div>
</header>
2 changes: 1 addition & 1 deletion docs/_layouts/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<!-- main body -->
<main id="content" class="main-content" role="main">
{{ content }}
{{ content | replace: '<a href="http', '<a rel="noopener nofollow" target="_blank" href="http' }}
</main>
<!-- scripts -->
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >-
This NuGet package is an open-source project.
Learn how to contribute issues, fixes, new indicators, new features, or to our discussions.
permalink: /contributing/
relative_path: contributing.md
relative_path: pages/contributing.md
layout: page
---

Expand Down
10 changes: 5 additions & 5 deletions docs/pages/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Guide and Pro tips
description: Learn how to use the Stock Indicators for .NET Nuget library in your own software tools and platforms. Whether you're just getting started or an advanced professional, this guide explains how to get setup, example usage code, and instructions on how to use historical price quotes, make custom quote classes, chain indicators of indicators, and create custom technical indicators.
permalink: /guide/
relative_path: guide.md
relative_path: pages/guide.md
layout: page
---

Expand Down Expand Up @@ -245,17 +245,17 @@ When a candlestick pattern is recognized, it produces a matching signal. In som
| type | int | description
|-- |--: |--
| `Match.BullConfirmed` | 200 | Confirmation of a prior bull signal
| `Match.BullSignal` | 100 | Matching bullish signal
| `Match.BullSignal` | 100 | Bullish signal
| `Match.BullBasis` | 10 | Bars supporting a bullish signal
| `Match.Neutral` | 1 | Matching for non-directional patterns
| `Match.Neutral` | 1 | Signal for non-directional patterns
| `Match.None` | 0 | No match
| `Match.BearBasis` | -10 | Bars supporting a bearish signal
| `Match.BearSignal` | -100 | Matching bearish signal
| `Match.BearSignal` | -100 | Bearish signal
| `Match.BearConfirmed` | -200 | Confirmation of a prior bear signal

### Candle

The `CandleProperties` class is an extended version of `Quote`, and contains additional calculated properties.
The `CandleProperties` class is an extended version of `Quote`, and contains additional calculated properties. `TQuote` classes can be converted to `CandleProperties` with the `.ToCandle()` [utility]({{site.baseurl}}/utilities/#extended-candle-properties), and further used as the basis for calculating indicators.

{% include candle-properties.md %}

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Performance benchmarks
description: The Stock Indicators for .NET library is built for speed and production workloads. Compare our execution times with other options.
permalink: /performance/
relative_path: performance.md
relative_path: pages/performance.md
layout: page
---

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Utilities and helpers
description: The Stock Indicators for .NET library includes utilities to help you use and transform historical prices quotes and indicator results, and to create custom indicators.
permalink: /utilities/
relative_path: utilities.md
relative_path: pages/utilities.md
layout: page
---

Expand Down
2 changes: 1 addition & 1 deletion src/Indicators.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<Authors>Dave Skender</Authors>
<Product>Stock Indicators for .NET</Product>
<Copyright>@2020 Dave Skender</Copyright>
<Description>Stock Indicators for .NET. Send in price quotes and get back desired technical analysis indicators such as MACD, Stochastic RSI, Average True Range, Parabolic SAR, etc. Nothing more.</Description>
<Description>Stock Indicators for .NET. Transform financial market price quotes into technical analysis indicators such as MACD, Stochastic RSI, Average True Range, Parabolic SAR, etc. Nothing more.</Description>

<RepositoryUrl>https://github.com/DaveSkender/Stock.Indicators</RepositoryUrl>
<RepositoryType>git</RepositoryType>
Expand Down

0 comments on commit 6c2b310

Please sign in to comment.