Skip to content

Commit

Permalink
(TA-Lib#2) Start rework of site/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mario4tier authored and konkist committed Aug 22, 2024
1 parent 66e3522 commit 8371753
Show file tree
Hide file tree
Showing 10 changed files with 243 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ta-lib.org
Empty file added docs/about.md
Empty file.
Empty file added docs/api.md
Empty file.
Binary file added docs/assets/images/home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file added docs/faq.md
Empty file.
139 changes: 139 additions & 0 deletions docs/functions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
| TA Function | Name |
|-------------|------|
|AD |Chaikin A/D Line|
|ADOSC |Chaikin A/D Oscillator|
|ADX |Average Directional Movement Index|
|ADXR |Average Directional Movement Index Rating|
|APO |Absolute Price Oscillator|
|AROON |Aroon|
|AROONOSC |Aroon Oscillator|
|ATR |Average True Range|
|AVGPRICE |Average Price|
|BBANDS |Bollinger Bands|
|BETA |Beta|
|BOP |Balance Of Power|
|CCI |Commodity Channel Index|
|CDL2CROWS |Two Crows|
|CDL3BLACKCROWS |Three Black Crows|
|CDL3INSIDE |Three Inside Up/Down|
|CDL3LINESTRIKE |Three Outside Up/Down|
|CDL3STARSINSOUTH |Three Stars In The South|
|CDL3WHITESOLDIERS |Three Advancing White Soldiers|
|CDLABANDONEDBABY |Abandoned Baby|
|CDLADVANCEBLOCK |Advance Block|
|CDLBELTHOLD |Belt-hold|
|CDLBREAKAWAY |Breakaway|
|CDLCLOSINGMARUBOZU |Closing Marubozu|
|CDLCONCEALBABYSWALL |Concealing Baby Swallow|
|CDLCOUNTERATTACK |Counterattack|
|CDLDARKCLOUDCOVER |Dark Cloud Cover|
|CDLDOJI |Doji|
|CDLDOJISTAR |Doji Star|
|CDLDRAGONFLYDOJI |Dragonfly Doji|
|CDLENGULFING |Engulfing Pattern|
|CDLEVENINGDOJISTAR |Evening Doji Star|
|CDLEVENINGSTAR |Evening Star|
|CDLGAPSIDESIDEWHITE |Up/Down-gap side-by-side white lines|
|CDLGRAVESTONEDOJI |Gravestone Doji|
|CDLHAMMER |Hammer|
|CDLHANGINGMAN |Hanging Man|
|CDLHARAMI |Harami Pattern|
|CDLHARAMICROSS |Harami Cross Pattern|
|CDLHIGHWAVE |High-Wave Candle|
|CDLHIKKAKE |Hikkake Pattern|
|CDLHIKKAKEMOD |Modified Hikkake Pattern|
|CDLHOMINGPIGEON |Homing Pigeon|
|CDLIDENTICAL3CROWS |Identical Three Crows|
|CDLINNECK |In-Neck Pattern|
|CDLINVERTEDHAMMER |Inverted Hammer|
|CDLKICKING |Kicking|
|CDLKICKINGBYLENGTH |Kicking - bull/bear determined by the longer marubozu |
|CDLLADDERBOTTOM |Ladder Bottom|
|CDLLONGLEGGEDDOJI |Long Legged Doji|
|CDLLONGLINE |Long Line Candle|
|CDLMARUBOZU |Marubozu|
|CDLMATCHINGLOW |Matching Low|
|CDLMATHOLD |Mat Hold|
|CDLMORNINGDOJISTAR |Morning Doji Star|
|CDLMORNINGSTAR |Morning Star|
|CDLONNECK |On-Neck Pattern|
|CDLPIERCING |Piercing Pattern|
|CDLRICKSHAWMAN |Rickshaw Man|
|CDLRISEFALL3METHODS |Rising/Falling Three Methods|
|CDLSEPARATINGLINES |Separating Lines|
|CDLSHOOTINGSTAR |Shooting Star|
|CDLSHORTLINE |Short Line Candle|
|CDLSPINNINGTOP |Spinning Top|
|CDLSTALLEDPATTERN |Stalled Pattern|
|CDLSTICKSANDWICH |Stick Sandwich|
|CDLTAKURI |Takuri (Dragonfly Doji with very long lower shadow)|
|CDLTASUKIGAP |Tasuki Gap|
|CDLTHRUSTING |Thrusting Pattern|
|CDLTRISTAR |Tristar Pattern|
|CDLUNIQUE3RIVER |Unique 3 River|
|CDLUPSIDEGAP2CROWS |Upside Gap Two Crows|
|CDLXSIDEGAP3METHODS |Upside/Downside Gap Three Methods|
|CMO |Chande Momentum Oscillator|
|CORREL |Pearson's Correlation Coefficient (r)|
|DEMA |Double Exponential Moving Average|
|DX |Directional Movement Index|
|EMA |Exponential Moving Average|
|HT_DCPERIOD |Hilbert Transform - Dominant Cycle Period|
|HT_DCPHASE |Hilbert Transform - Dominant Cycle Phase|
|HT_PHASOR |Hilbert Transform - Phasor Components|
|HT_SINE |Hilbert Transform - SineWave|
|HT_TRENDLINE |Hilbert Transform - Instantaneous Trendline|
|HT_TRENDMODE |Hilbert Transform - Trend vs Cycle Mode|
|KAMA |Kaufman Adaptive Moving Average|
|LINEARREG |Linear Regression|
|LINEARREG_ANGLE |Linear Regression Angle|
|LINEARREG_INTERCEPT |Linear Regression Intercept|
|LINEARREG_SLOPE |Linear Regression Slope|
|MA |All Moving Average|
|MACD |Moving Average Convergence/Divergence|
|MACDEXT |MACD with controllable MA type|
|MACDFIX |Moving Average Convergence/Divergence Fix 12/26|
|MAMA |MESA Adaptive Moving Average|
|MAX |Highest value over a specified period|
|MAXINDEX |Index of highest value over a specified period|
|MEDPRICE |Median Price|
|MFI |Money Flow Index|
|MIDPOINT |MidPoint over period|
|MIDPRICE |Midpoint Price over period|
|MIN |Lowest value over a specified period|
|MININDEX |Index of lowest value over a specified period|
|MINMAX |Lowest and highest values over a specified period|
|MINMAXINDEX |Indexes of lowest and highest values over a specified period|
|MINUS_DI |Minus Directional Indicator|
|MINUS_DM |Minus Directional Movement|
|MOM |Momentum|
|NATR |Normalized Average True Range|
|OBV |On Balance Volume|
|PLUS_DI |Plus Directional Indicator|
|PLUS_DM |Plus Directional Movement|
|PPO |Percentage Price Oscillator|
|ROC |Rate of change : ((price/prevPrice)-1)*100|
|ROCP |Rate of change Percentage: (price-prevPrice)/prevPrice|
|ROCR |Rate of change ratio: (price/prevPrice)|
|ROCR100 |Rate of change ratio 100 scale: (price/prevPrice)*100|
|RSI |Relative Strength Index|
|SAR |Parabolic SAR|
|SAREXT |Parabolic SAR - Extended|
|SMA |Simple Moving Average|
|STDDEV |Standard Deviation|
|STOCH |Stochastic|
|STOCHF |Stochastic Fast|
|STOCHRSI |Stochastic Relative Strength Index|
|SUM |Summation|
|T3 |Triple Exponential Moving Average (T3)|
|TEMA |Triple Exponential Moving Average|
|TRANGE |True Range|
|TRIMA |Triangular Moving Average|
|TRIX |1-day Rate-Of-Change (ROC) of a Triple Smooth EMA|
|TSF |Time Series Forecast|
|TYPPRICE |Typical Price|
|ULTOSC |Ultimate Oscillator|
|VAR |Variance|
|WCLPRICE |Weighted Close Price|
|WILLR |Williams' %R|
|WMA |Weighted Moving Average|
20 changes: 20 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
hide:
- navigation
- toc
---
#
<figure markdown>
![TA-Lib](assets/images/home.png)
</figure>
<h3 align="center">Use TA-Lib to add technical analysis to your own financial market trading appplications</h3>

* Includes 200 indicators such as ADX, MACD, RSI, Stochastic, Bollinger Bands etc... [:octicons-arrow-right-24: See complete list...](functions.md)

* Candlestick pattern recognition

* Core written in [C/C++](api.md) with API also available for [Python](https://ta-lib.github.io/ta-lib-python/).

* Open-Source (BSD License). Can be freely integrated in your own open-source or commercial applications.

The code is stable and has passed the test of time. TA-Lib was release more than 20 years ago for well-known algorithms that are still widely in use today.
Empty file added docs/install.md
Empty file.
Empty file added docs/wrappers.md
Empty file.
83 changes: 83 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
site_name: TA-Lib - Technical Analysis Library
site_author: Mario Fortier
site_description: >-
Open-Source library for technical analysis of time series and trading data
# Repository
repo_name: Github (Core C Library)
repo_url: https://github.com/TA-Lib/ta-lib

theme:
name: material
icon:
logo: material/cog-box
repo: fontawesome/brands/github
features:
# - announce.dismiss
- content.code.annotate
# - content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.indexes
- navigation.instant
# - navigation.prune
- navigation.sections
- navigation.tabs
- navigation.footer
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow

markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
#- toc:
# permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:materialx.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.keys
#- pymdownx.magiclink:
# repo_url_shorthand: true
# user: squidfunk
# repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde

nav:
- Home: index.md
- Install: install.md
- Docs:
- Functions List: functions.md
- C/C++ API: api.md
- Python, Rust and Other: wrappers.md
- FAQ: faq.md
- About Us: about.md

0 comments on commit 8371753

Please sign in to comment.