Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: DocFX baseline (experiment) #1251

Draft
wants to merge 7 commits into
base: v3
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -327,8 +327,5 @@ ASALocalRun/
# MFractors (Xamarin productivity tool) working folder
.mfractor/

# Jekyll site
_site/

# zip artifacts
.DS_Store
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@

**Stock Indicators for .NET** is a C# [library package](https://www.nuget.org/packages/Skender.Stock.Indicators) that produces financial market technical indicators. Send in historical price quotes and get back desired indicators such as moving averages, Relative Strength Index, Stochastic Oscillator, Parabolic SAR, etc. Nothing more.

Build your technical analysis, trading algorithms, machine learning, charting, or other intelligent market software with this library and your own [OHLCV](https://dotnet.stockindicators.dev/guide/#historical-quotes) price quotes sources for equities, commodities, forex, cryptocurrencies, and others. [Stock Indicators for Python](https://python.stockindicators.dev/) is also available.
Build your technical analysis, trading algorithms, machine learning, charting, or other intelligent market software with this library and your own [OHLCV](https://dotnet.stockindicators.dev/guide.md#historical-quotes) price quotes sources for equities, commodities, forex, cryptocurrencies, and others. [Stock Indicators for Python](https://python.stockindicators.dev/) is also available.

Visit our project site for more information:

- [Overview](https://dotnet.stockindicators.dev/)
- [Indicators and overlays](https://dotnet.stockindicators.dev/indicators/)
- [Guide and Pro tips](https://dotnet.stockindicators.dev/guide/)
- [Guide and Pro tips](https://dotnet.stockindicators.dev/guide.md)
- [Demo site](https://charts.stockindicators.dev/) (a stock chart)
- [Release notes](https://github.com/DaveSkender/Stock.Indicators/releases)
- [Discussions](https://github.com/DaveSkender/Stock.Indicators/discussions)
Expand Down
3 changes: 3 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# DocFX
_site/
api/
11 changes: 0 additions & 11 deletions docs/404.html

This file was deleted.

17 changes: 0 additions & 17 deletions docs/GemFile

This file was deleted.

304 changes: 0 additions & 304 deletions docs/GemFile.lock

This file was deleted.

2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Visit [dotnet.stockindicators.dev](https://dotnet.stockindicators.dev) to read our documentation.

It is developed with Jekyll for GitHub Pages and is not intended to be read from the code repo.
It is developed with DocFX and is not intended to be read from the code repo.
3 changes: 1 addition & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Ref: https://jekyllrb.com/docs/usage/
# Local dev: bundle exec jekyll serve --livereload
### YamlMime:ManagedReference

title: Stock Indicators for .NET
tagline: "Transform price quotes into trading insights."
Expand Down
4 changes: 2 additions & 2 deletions docs/_includes/candle-result.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@

**`Price`** _`decimal`_ - Price of the most relevant OHLC candle element when a signal is present

**`Match`** _`Match`_ - Indicates a [matching signal type]({{site.baseurl}}/guide/#match) for this candlestick pattern
**`Match`** _`Match`_ - Indicates a [matching signal type](pages/guide.md#match) for this candlestick pattern

**`Candle`** _`CandleProperties`_ - Details of the [candle properties]({{site.baseurl}}/guide/#candle)
**`Candle`** _`CandleProperties`_ - Details of the [candle properties](pages/guide.md#candle)
Loading