Skip to content

Commit aedc748

Browse files
committed
Add mkdocs
1 parent d656ecb commit aedc748

File tree

4 files changed

+90
-5
lines changed

4 files changed

+90
-5
lines changed

docs/index.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
# QTradingView
22

3-
Welcome to the QTradingView documentation!
3+
[![Build](https://img.shields.io/github/actions/workflow/status/dhruvan2006/QTradingView/build.yml?branch=main)]()
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)]()
5+
[![Demo](https://img.shields.io/badge/demo-online-brightgreen)]()
6+
[![C++](https://img.shields.io/badge/C++-17-blue)]()
7+
[![Qt](https://img.shields.io/badge/Qt-6-green)]()
8+
9+
QTradingView is a **lightweight, high-performance charting library** built in **C++ & Qt**, inspired by TradingView.
410

511
## Live Demo
612

713
<iframe src="demo/index.html" width="100%" height="500px" style="border:none;"></iframe>
814

9-
## Getting Started
10-
See [Getting Started](getting-started.md) for installation and setup instructions.
15+
---
16+
17+
### Quick Links
18+
19+
- [Installation](installation.md)
20+
- [Usage](usage.md)
21+
- [Examples](examples/candlestick.md)

docs/installation.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Installation
2+
3+
QTradingView can be easily integrated using **CMake**:
4+
5+
```cmake
6+
cmake_minimum_required(VERSION 3.16)
7+
project(MyProject)
8+
9+
include(FetchContent)
10+
11+
FetchContent_Declare(
12+
QTradingView
13+
GIT_REPOSITORY https://github.com/dhruvan2006/QTradingView.git
14+
GIT_TAG v1.0.0
15+
)
16+
17+
FetchContent_MakeAvailable(QTradingView)
18+
19+
add_executable(MyApp main.cpp)
20+
target_link_libraries(MyApp PRIVATE QTradingView::QTradingView)
21+
```

docs/usage.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Usage
2+
3+
## Basic Chart
4+
5+
```c++
6+
auto chart = new QTradingView::Chart();
7+
auto pane = chart->addPane(1.0);
8+
pane->addSeries(std::make_shared<QTradingView::CandleStickSeries>(data));
9+
chart->show();
10+
```
11+
12+
[//]: # (TODO: Add more usage examples and details.)
13+
14+
## Themes
15+
```c++
16+
chart->setTheme(QTradingView::ChartTheme::tradingViewDark());
17+
chart->setTheme(QTradingView::ChartTheme::tradingViewLight());
18+
```

mkdocs.yml

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,40 @@
1-
site_name: QTradingView Docs
1+
site_name: QTradingView
2+
site_url: https://dhruvan2006.github.io/QTradingView
3+
repo_url: https://github.com/dhruvan2006/QTradingView
4+
repo_name: GitHub
5+
site_description: Lightweight, high-performance C++ & Qt charting library inspired by TradingView.
26
theme:
37
name: material
8+
palette:
9+
- scheme: default
10+
primary: blue
11+
accent: orange
12+
- scheme: slate
13+
primary: blue
14+
accent: orange
15+
font:
16+
text: Roboto
17+
code: Roboto Mono
18+
features:
19+
- navigation.tabs
20+
- navigation.top
21+
- search.highlight
22+
- instant
23+
markdown_extensions:
24+
- admonition
25+
- codehilite
26+
- pymdownx.superfences
27+
- pymdownx.snippets
28+
- pymdownx.tabbed
29+
- toc:
30+
permalink: true
431
nav:
5-
- Home: index.md
32+
- Home: index.md
33+
- Installation: installation.md
34+
- Usage: usage.md
35+
- API Reference: api/index.html
36+
- Architecture: architecture.md
37+
- Examples:
38+
- Candlestick Chart: examples/candlestick.md
39+
- Multi-Pane Chart: examples/multi-pane.md
40+
- Line Chart: examples/line-chart.md

0 commit comments

Comments
 (0)