mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
Hugo docs (#2415)
* improve documentation page * some updates * small improvements * small improvements * small improvements * fixes with rita Co-authored-by: guanquann <tanguanquan@yahoo.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
This commit is contained in:
jose-donato
3
website/config.toml
vendored
3
website/config.toml
vendored
@@ -1,5 +1,4 @@
|
||||
baseURL = "https://openbb-finance.github.io/OpenBBTerminal"
|
||||
title = "OpenBB Documentation"
|
||||
theme = "hugo-geekdoc"
|
||||
|
||||
# Required to get well formatted code blocks
|
||||
@@ -24,7 +23,7 @@ enableGitInfo = true
|
||||
|
||||
# (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc
|
||||
# relative to your 'static/' folder.
|
||||
geekdocLogo = "openbb_logo.png"
|
||||
geekdocLogo = "openbb_logo.svg"
|
||||
|
||||
# (Optional, default false) Render menu from data file im 'data/menu/main.yaml'.
|
||||
geekdocMenuBundle = true
|
||||
|
||||
55
website/content/_index.md
vendored
55
website/content/_index.md
vendored
@@ -1,18 +1,21 @@
|
||||
---
|
||||
title: Getting Started
|
||||
title: OpenBB Terminal Documentation
|
||||
keywords: "getting started, openbb, api, beginner guide, how to use openbb, openbb keys, openbb terminal, openbb, terminal"
|
||||
excerpt: "This page guides you how to use the OpenBB terminal, developed by OpenBB."
|
||||
description: "The OpenBB Documentation provides guidance on how to use the OpenBB Terminal, a free, custom built
|
||||
financial terminal that will help you make more informed decisions, faster."
|
||||
geekdocCollapseSection: true
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
OpenBB is a leading open source investment research software platform for accessing and analyzing financial market data.
|
||||
We represent millions of investors who want to leverage state-of-the-art data science and machine learning technologies
|
||||
to make sense of raw unrefined data. Our mission is to make investment research effective, powerful and accessible to everyone.
|
||||
|
||||
**All our products are Free and Open-Source (FOSS).**
|
||||
---
|
||||
|
||||
## The OpenBB Terminal is Free and Open-Source (FOSS)
|
||||
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable MD033 -->
|
||||
@@ -25,11 +28,6 @@ to make sense of raw unrefined data. Our mission is to make investment research
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
|
||||
---
|
||||
<center><b><span style="color:white">If you are interested in the <span style="color:orange">OpenBB Terminal</span>,
|
||||
please continue reading this page and the related pages on each menu (e.g. <a href="terminal/stocks">Stocks</a>
|
||||
or <a href="terminal/economy">Economy</a>)</span></b></center>
|
||||
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
@@ -55,7 +53,6 @@ An open source product allows for higher quality, lower costs, more transparency
|
||||
|
||||
We believe that everyone should be able to have the same tooling to do investment research. By leveraging free API tiers, we can allow users to have access to a vast range of information for free. On the other hand, we want users that are willing to subscribe to premium API keys from certain data providers to be able to take advantage of that on OpenBB Terminal - this is where we see a monetization opportunity, a revenue share with data providers for connecting our users to their resources.
|
||||
|
||||
|
||||
{{< /columns >}}
|
||||
|
||||
{{< columns >}}
|
||||
@@ -157,7 +154,6 @@ If you have trouble launching the app because of security settings and the "Righ
|
||||
|
||||
<p align="center"><img width=60% alt="image" src="https://user-images.githubusercontent.com/11668535/173027428-a85890d7-8a3c-4954-a6c0-d3214c635982.png"></p>
|
||||
|
||||
|
||||
## Structure of the OpenBB Terminal
|
||||
|
||||
The OpenBB Terminal is based off the <a href="https://en.wikipedia.org/wiki/Command-line_interface" target="_blank">Command Line Interface (CLI)</a>
|
||||
@@ -169,6 +165,7 @@ you are greeted with the following interface:
|
||||
The OpenBB Terminal is centered around keyboard input. To navigate and perform analysis you will have to type in the name of the command followed by an `ENTER` (⏎). If you wish to see information about the OpenBB Terminal you can do so by typing `about` and then press `ENTER` (⏎). As you are typing, you will notice that you receive suggestions, by using the `DOWN` (⌄) arrow and pressing `ENTER` (⏎) you can select the command and execute it.
|
||||
|
||||
Throughout the entire terminal, the same set of colors are used which all share the same representation. This is structured as follows:
|
||||
|
||||
- <b><span style="color:#00AAFF">Light Blue</span></b>: represents commands.
|
||||
- <b><span style="color:#005CA9">Dark Blue</span></b>: represents menus, also recognizable by the `>` in front.
|
||||
- <b><span style="color:#EF7D00">Orange</span></b>: represents titles and headers.
|
||||
@@ -188,11 +185,13 @@ and menus you can select. There are interactions in place between each menu. For
|
||||
the `stocks` menu, the terminal will remember your selection when you visit the `fa` or `options` menu.
|
||||
See <a href="terminal/stocks" target="_blank">Introduction to Stocks</a> for more information.
|
||||
|
||||
___
|
||||
---
|
||||
|
||||
**Pro tip:** you can quickly jump between menus by using a forward slash (`/`). For example, if I want to access the options
|
||||
menu, I can type `/stocks/options` to instantly arrive at this menu. You can do this from any location within the
|
||||
OpenBB Terminal!
|
||||
___
|
||||
|
||||
---
|
||||
|
||||
### Explanation of Commands
|
||||
|
||||
@@ -202,10 +201,10 @@ the commands that you are able to use from any menu in the terminal (see <a href
|
||||
- `cls`: clears the screen, by executing this command you are left with an empty screen.
|
||||
- `help`, `h` or `?`: displays the menu that you are currently on.
|
||||
- `quit`, `q` or `..`: allows for navigation through the menu. E.g. if you type `stocks` press `ENTER` (⏎) and then
|
||||
use `q` and press `ENTER` (⏎) you return to where you started. Validate this by typing `?` and pressing `ENTER` (⏎).
|
||||
use `q` and press `ENTER` (⏎) you return to where you started. Validate this by typing `?` and pressing `ENTER` (⏎).
|
||||
- `support`: allows you to submit bugs, questions and suggestions.
|
||||
- `about`: this opens the related guide, linking to this website. It also has the ability to open a guide to a specific
|
||||
command. For example, within the `stocks` menu, `about candle` opens <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/stocks/candle/" target="_blank">this guide</a>.
|
||||
command. For example, within the `stocks` menu, `about candle` opens <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/stocks/candle/" target="_blank">this guide</a>.
|
||||
|
||||
Continuing with the example mentioned at `quit`, revisit the `stocks` menu and look at the commands. At the top you
|
||||
will see a command named <a href="terminal/stocks/load" target="_blank">load</a>. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following:
|
||||
@@ -299,14 +298,15 @@ selected period.
|
||||
```
|
||||
2022 May 19, 05:44 (🦋) /stocks/ $ candle
|
||||
```
|
||||
|
||||
<a target="_blank" href="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png"><img src="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png" alt="Amazon Candle Chart" width="800"/></a>
|
||||
|
||||
As mentioned in the <a href="#explanation-of-menus">Explanation of Menus</a>, some information also transfers over to other menus and this includes the
|
||||
loaded market data from <a href="terminal/stocks/load" target="_blank">load</a>.
|
||||
So, if you would visit the `ta` menu (which stands for <a href="https://www.investopedia.com/terms/t/technicalanalysis.asp" target="_blank">Technical Analysis</a>) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`.
|
||||
|
||||
|
||||
### Explanation of Scripts
|
||||
|
||||
The `.openbb` scripts offer the ability to automatically run a set of commands in the form of a **routine**. Furthermore,
|
||||
the scripts can be adapted, and documented, at any moment giving the user full control over the type of analysis you wish
|
||||
to do (and repeat). This can fundamental research, understanding market movements, finding hidden gems and even
|
||||
@@ -327,7 +327,7 @@ Within this menu you are able to set your API keys to access the commands that r
|
||||
To figure out where you can obtain the API key, you can enter the command (e.g. `av`) and press `ENTER` (⏎) or use the table below. **We recommend that you gradually obtain and set keys whenever you wish to use features that require an API key. For example, if you are interested in viewing recent news about a company, you should set the API key from the 'News API'.**
|
||||
|
||||
| Command | Name | URL |
|
||||
|:-----------|:-----------------------------------------|:-----------------------------------------------------------------------------------|
|
||||
| :--------- | :--------------------------------------- | :--------------------------------------------------------------------------------- |
|
||||
| av | AlphaVantage | https://www.alphavantage.co/support/#api-key |
|
||||
| fmp | Financial Modelling Prep | https://site.financialmodelingprep.com/developer/docs/ |
|
||||
| quandl | Quandl | https://www.quandl.com |
|
||||
@@ -364,34 +364,36 @@ There is a large collection of (sub) menus available. Here, the asset class and
|
||||
The asset class menus are as follows:
|
||||
|
||||
- <a href="terminal/stocks" target="_blank">Introduction to Stocks</a>: access historical pricing data, options, sector and
|
||||
industry analysis, and overall due diligence.
|
||||
industry analysis, and overall due diligence.
|
||||
- <a href="terminal/crypto" target="_blank">Introduction to Crypto</a>: dive into onchain data, tokenomics, circulation supply,
|
||||
nfts and more.
|
||||
nfts and more.
|
||||
- <a href="terminal/etf" target="_blank">Introduction to ETF</a>: explore exchange traded funds, historical pricing, holdings
|
||||
and screeners.
|
||||
and screeners.
|
||||
- <a href="terminal/forex" target="_blank">Introduction to Forex</a>: see foreign exchanges, quotes, forward rates for currency
|
||||
pairs and Oanda integration.
|
||||
pairs and Oanda integration.
|
||||
- <a href="terminal/funds" target="_blank">Introduction to Funds</a>: discover mutual funds, general overviews, holdings and
|
||||
sector weights.
|
||||
sector weights.
|
||||
|
||||
The other menus are as follows:
|
||||
|
||||
- <a href="terminal/economy" target="_blank">Introduction to Economy</a>: explore global macroeconomic data including
|
||||
interest and inflation rates, GDP and its components, futures, yield curves and treasury rates.
|
||||
interest and inflation rates, GDP and its components, futures, yield curves and treasury rates.
|
||||
- <a href="terminal/alternative" target="_blank">Introduction to Alternative</a>: explore alternative datasets such as COVID and
|
||||
open source metrics.
|
||||
open source metrics.
|
||||
- <a href="terminal/econometrics" target="_blank">Introduction to Econometrics</a>: perform (advanced) regression techniques and
|
||||
statistical tests on custom datasets to understand relationships for both time series and panel data.
|
||||
statistical tests on custom datasets to understand relationships for both time series and panel data.
|
||||
- <a href="terminal/portfolio" target="_blank">Introduction to Portfolio</a>: understand how your portfolio evolved over time, what
|
||||
assets contributed the most to this performance, compare this to a benchmark and make adjustments via various portfolio
|
||||
optimization techniques.
|
||||
assets contributed the most to this performance, compare this to a benchmark and make adjustments via various portfolio
|
||||
optimization techniques.
|
||||
- <a href="terminal/jupyter" target="_blank">Introduction to Dashboards</a>: see interactive dashboards using voila and
|
||||
jupyter notebooks.
|
||||
jupyter notebooks.
|
||||
- Introduction to Reports <b>(Work in Progress)</b>: create customizable research reports through jupyter notebooks.
|
||||
|
||||
## Customizing the terminal
|
||||
|
||||
To adjust the lay-out and settings of the OpenBB Terminal you can access the `settings` menu. This menu allows you to
|
||||
tweak how the terminal behaves. This includes the following:
|
||||
|
||||
- `dt` adds or removes the datetime from the flair (which is next to the emoji).
|
||||
- `flair` allows you to change the emoji that is used.
|
||||
- `lang` gives the ability to change the terminal language. At this moment, the terminal is only available in English.
|
||||
@@ -409,6 +411,7 @@ tweak how the terminal behaves. This includes the following:
|
||||
|
||||
Next to that, to enable or disable certain functionalities of the terminal you can use the `featflags` menu which
|
||||
includes the following:
|
||||
|
||||
- `logcollection` whether you wish to enable logging to help the OpenBB team improve functionalities (default is yes).
|
||||
- `retryload` whenever you misspell commands, try to use the `load` command with it first (default is no).
|
||||
- `tab` whether to use tabulate to print DataFrames, to prettify these DataFrames (default is yes).
|
||||
|
||||
8
website/data/menu/more.yml
vendored
8
website/data/menu/more.yml
vendored
@@ -1,11 +1,15 @@
|
||||
---
|
||||
more:
|
||||
- name: "Go to main website"
|
||||
ref: "https://openbb.co"
|
||||
external: true
|
||||
icon: "gdoc_link"
|
||||
- name: "Install the Terminal"
|
||||
ref: "https://www.openbb.co/products/terminal"
|
||||
ref: "https://openbb.co/products/terminal"
|
||||
external: true
|
||||
icon: "gdoc_download"
|
||||
- name: "Fill in the Survey"
|
||||
ref: "https://www.openbb.co/survey"
|
||||
ref: "https://openbb.co/survey"
|
||||
external: true
|
||||
icon: "gdoc_bookmark"
|
||||
- name: "View Source"
|
||||
|
||||
1504
website/public/index.html
vendored
1504
website/public/index.html
vendored
File diff suppressed because one or more lines are too long
12
website/public/main-5e7fc0c942.min.css
vendored
12
website/public/main-5e7fc0c942.min.css
vendored
@@ -280,7 +280,7 @@ code {
|
||||
--body-font-color: #343a40;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #7749bf;
|
||||
--code-background: #f5f6f8;
|
||||
--code-accent-color: #e3e7eb;
|
||||
@@ -754,7 +754,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1099,7 +1099,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1444,7 +1444,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1998,8 +1998,8 @@ img {
|
||||
.gdoc-search__entry.is-active,
|
||||
.gdoc-search__entry:hover {
|
||||
text-decoration: underline;
|
||||
-webkit-text-decoration-style: dashed !important;
|
||||
text-decoration-style: dashed !important;
|
||||
-webkit-text-decoration-style: underline !important;
|
||||
text-decoration-style: underline !important;
|
||||
}
|
||||
.gdoc-nav__entry:visited,
|
||||
.gdoc-search__entry:visited {
|
||||
|
||||
12
website/public/main-cc3cbe901b.min.css
vendored
12
website/public/main-cc3cbe901b.min.css
vendored
@@ -277,7 +277,7 @@ code {
|
||||
--body-font-color: #343a40;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #7749bf;
|
||||
--code-background: #f5f6f8;
|
||||
--code-accent-color: #e3e7eb;
|
||||
@@ -736,7 +736,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1081,7 +1081,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1426,7 +1426,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1980,8 +1980,8 @@ img {
|
||||
.gdoc-search__entry.is-active,
|
||||
.gdoc-search__entry:hover {
|
||||
text-decoration: underline;
|
||||
-webkit-text-decoration-style: dashed !important;
|
||||
text-decoration-style: dashed !important;
|
||||
-webkit-text-decoration-style: underline !important;
|
||||
text-decoration-style: underline !important;
|
||||
}
|
||||
.gdoc-nav__entry:visited,
|
||||
.gdoc-search__entry:visited {
|
||||
|
||||
9
website/static/openbb_logo.svg
vendored
Normal file
9
website/static/openbb_logo.svg
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
<svg width="160" height="16" viewBox="0 0 160 16" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M99.8659 1.7774V2.66723V3.55495V4.44478V5.33249V6.22232V7.11003V7.99986V8.88757V9.7774V10.6651V11.5549V12.4448L98.961 11.5549L98.0583 10.6651L97.1533 9.7774L96.2506 8.88757L95.3457 7.99986L94.4408 7.11003L93.538 6.22232L92.6331 5.33249L91.7303 4.44478L90.8254 3.55495L89.9227 2.66723L89.0178 1.7774H88.115H87.2101V2.66723V3.55495V4.44478V5.33249V6.22232V7.11003V7.99986V8.88757V9.7774V10.6651V11.5549V12.4448V13.3325V14.2223V15.11V15.9999H88.115H89.0178V15.11V14.2223V13.3325V12.4448V11.5549V10.6651V9.7774V8.88757V7.99986V7.11003V6.22232V5.33249V4.44478L89.9227 5.33249L90.8254 6.22232L91.7303 7.11003L92.6331 7.99986L93.538 8.88757L94.4408 9.7774L95.3457 10.6651L96.2506 11.5549L97.1533 12.4448L98.0583 13.3325L98.961 14.2223L99.8659 15.11L100.769 15.9999H101.674V15.11V14.2223V13.3325V12.4448V11.5549V10.6651V9.7774V8.88757V7.99986V7.11003V6.22232V5.33249V4.44478V3.55495V2.66723V1.7774H100.769H99.8659Z" fill="white" />
|
||||
<path d="M128.969 7.11215H127.162V1.7774H116.316V15.9999H130.781V7.10156H128.974L128.969 7.11215ZM118.123 6.22231V3.55071H125.354V7.10791H118.123V6.22231ZM128.969 9.7774V14.2266H118.123V8.88969H128.969V9.7774Z" fill="white" />
|
||||
<path d="M158.965 7.11229H156.255V1.77754H145.407V0H143.599V1.77754H145.407V16H159.868V7.1017L158.965 7.11229ZM147.214 6.22246V3.55085H154.447V7.10805H147.214V6.22246ZM158.063 9.77754V14.2267H147.214V8.88983H158.063V9.77754Z" fill="white" />
|
||||
<path d="M70.8833 1.7774H70.8789H69.9783H69.0756H68.1707H67.2679H66.363H65.4602H64.5553H63.6526H62.7477H61.8449H60.94H60.0351H59.1323H58.2274V2.66723V3.55495V4.44478V5.33249V6.22232V7.11003V7.99986V8.88757V9.7774V10.6651V11.5549V12.4448V13.3325V14.2223V15.11V15.9999H59.1323H60.0351H60.94H61.8449H62.7477H63.6526H64.5553H65.4602H66.363H67.2679H68.1707H69.0756H69.9783H70.8789H70.8833H71.7839H72.6866V15.11V14.2223H71.7839H70.8833H70.8789H69.9783H69.0756H68.1707H67.2679H66.363H65.4602H64.5553H63.6526H62.7477H61.8449H60.94H60.0351V13.3325V12.4448V11.5549V10.6651H60.94H61.8449H62.7477H63.6526H64.5553H65.4602H66.363H67.2679H68.1664H68.1707H69.0713H69.974H70.8789V9.7774V8.88757H69.974H69.0713H68.1707H68.1664H67.2679H66.363H65.4602H64.5553H63.6526H62.7477H61.8449H60.94H60.0351V7.99986V7.11003V6.22232V5.33249V4.44478V3.55495H60.94H61.8449H62.7477H63.6526H64.5553H65.4602H66.363H67.2679H68.1707H69.0756H69.9783H70.8789H70.8833H71.7839H72.6866V2.66723V1.7774H71.7839H70.8833Z" fill="white" />
|
||||
<path d="M12.6537 1.77742H0V15.9999H14.4635V1.77742H12.6558H12.6537ZM12.6537 4.44479V14.2223H1.80549V3.55072H12.6537V4.44479Z" fill="white" />
|
||||
<path d="M41.7852 1.77743H29.1315V15.9999H30.9392V10.6673H43.5929V1.76895H41.7852V1.77743ZM41.7852 4.44479V8.89394H30.9392V3.55073H41.7852V4.44479Z" fill="white" />
|
||||
</svg>
|
||||
|
||||
|
After Width: | Height: | Size: 2.8 KiB |
@@ -23,7 +23,7 @@
|
||||
|
||||
<main class="flex flex-even">
|
||||
{{ if $navEnabled }}
|
||||
<aside class="gdoc-nav" style="background-color: #151515">
|
||||
<aside class="gdoc-nav" style="background-color: #070707">
|
||||
{{ partial "menu" . }}
|
||||
</aside>
|
||||
{{ end }}
|
||||
@@ -33,7 +33,7 @@
|
||||
style="
|
||||
padding-right: 20px;
|
||||
padding-left: 20px;
|
||||
background-color: #1e1e1e;
|
||||
background-color: #131313;
|
||||
"
|
||||
>
|
||||
{{ template "main" . }} {{ partial "page-footer" . }}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
{{- $content := .Content -}}
|
||||
{{- $content = $content | replaceRE `<nav id="TableOfContents">\s*<ul>\s*<li>\s*<ul>` `<nav id="TableOfContents"><ul>` | replaceRE `</ul>\s*</li>\s*</ul>\s*</nav>` `</ul></nav>` | safeHTML -}}
|
||||
{{- $content = $content | replaceRE `<nav id="TableOfContents">\s*<ul>\s*<li>\s*<ul>` `<nav id="TableOfContents"><ol>` | replaceRE `</ul>\s*</li>\s*</ul>\s*</nav>` `</ul></nav>` | safeHTML -}}
|
||||
{{- $content = $content | replaceRE `(<table>(?:.|\n)+?</table>)` `<div class=table-wrap> ${1} </div>` | safeHTML -}}
|
||||
{{- $content -}}
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
<script src="{{ index .Site.Data.assets "js/darkmode.min.js" | relURL }}"></script>
|
||||
|
||||
<link rel="preload" as="font" href="{{ "fonts/Metropolis.woff2" | relURL }}" type="font/woff2" crossorigin="anonymous">
|
||||
<link rel="preload" as="font" href="{{ "fonts/LiberationSans.woff2" | relURL }}" type="font/woff2" crossorigin="anonymous">
|
||||
<link rel="preconnect" href="https://fonts.googleapis.com">
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||||
<link href="https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;700&display=swap" rel="stylesheet">
|
||||
|
||||
<link rel="preload" href="{{ index .Site.Data.assets "main.min.css" | relURL }}" as="style">
|
||||
<link rel="stylesheet" href="{{ index .Site.Data.assets "main.min.css" | relURL }}" media="all">
|
||||
@@ -16,8 +17,35 @@
|
||||
<link rel="stylesheet" href="{{ index .Site.Data.assets "custom.css" | relURL }}" media="all">
|
||||
|
||||
<style>
|
||||
|
||||
body {
|
||||
font-family: 'Fira Code', sans-serif !important;
|
||||
}
|
||||
|
||||
.container {
|
||||
max-width: 97rem;
|
||||
}
|
||||
|
||||
.gdoc-brand__img {
|
||||
width: 160px;
|
||||
height: 16px;
|
||||
display: block !important;
|
||||
}
|
||||
|
||||
.gdoc-nav__list {
|
||||
margin-left: 8px;
|
||||
}
|
||||
|
||||
.gdoc-toc a, .gdoc-toc a:visited {
|
||||
color: white;
|
||||
}
|
||||
|
||||
.gdoc-search:active, .gdoc-search:focus-within {
|
||||
border: 1px solid #FFFFFF !important;
|
||||
}
|
||||
|
||||
._btn {
|
||||
text-decoration: none !important;
|
||||
text-decoration: none !important;
|
||||
display: inline-flex;
|
||||
width: 100%;
|
||||
align-items: center;
|
||||
@@ -37,13 +65,14 @@
|
||||
transition-timing-function: cubic-bezier(0, 0, 0.2, 1);
|
||||
background-color: #eaeaeaff;
|
||||
color: #2a2a2aff !important;
|
||||
width: -webkit-fit-content;
|
||||
width: -moz-fit-content;
|
||||
width: fit-content;
|
||||
}
|
||||
|
||||
@media (min-width: 768px) {
|
||||
@media (max-width: 768px) {
|
||||
._btn {
|
||||
width: -webkit-fit-content;
|
||||
width: -moz-fit-content;
|
||||
width: fit-content;
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -78,6 +107,86 @@
|
||||
background-color: #c8c8c8ff;
|
||||
color: #808080ff;
|
||||
}
|
||||
|
||||
.navlink {
|
||||
transition-property: color, background-color, border-color, fill, stroke, opacity, box-shadow, transform, filter, -webkit-text-decoration-color, -webkit-backdrop-filter;
|
||||
transition-property: color, background-color, border-color, text-decoration-color, fill, stroke, opacity, box-shadow, transform, filter, backdrop-filter;
|
||||
transition-property: color, background-color, border-color, text-decoration-color, fill, stroke, opacity, box-shadow, transform, filter, backdrop-filter, -webkit-text-decoration-color, -webkit-backdrop-filter;
|
||||
transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);
|
||||
transition-duration: 150ms;
|
||||
transition-timing-function: cubic-bezier(0, 0, 0.2, 1);
|
||||
box-sizing: border-box;
|
||||
font-size: 0.875rem;
|
||||
line-height: 1.25rem;
|
||||
color: #a2a2a2ff !important;
|
||||
}
|
||||
|
||||
.navlink:hover {
|
||||
color: #ffffffff !important;
|
||||
text-decoration: none !important;
|
||||
}
|
||||
|
||||
.navlink:focus {
|
||||
border-radius: 4px;
|
||||
border-color: #ffffffff;
|
||||
color: #ffffffff;
|
||||
}
|
||||
|
||||
.navlink:active {
|
||||
color: #ffffffff;
|
||||
}
|
||||
|
||||
.navlink:disabled {
|
||||
cursor: not-allowed;
|
||||
--tw-text-opacity: 1;
|
||||
color: rgb(88 88 88 / var(--tw-text-opacity));
|
||||
}
|
||||
|
||||
h1 {
|
||||
text-transform: uppercase;
|
||||
font-weight: 700;
|
||||
letter-spacing: 0.1em;
|
||||
font-size:20px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 18px;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 16px;
|
||||
}
|
||||
|
||||
p {
|
||||
color: #EAEAEA !important;
|
||||
}
|
||||
|
||||
@media (max-width: 500px) {
|
||||
._hide-on-mobile {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
code, img {
|
||||
background-color: #404040 !important;
|
||||
color: white !important;
|
||||
border-radius: .375rem !important;
|
||||
border: 1px solid #5a5a5a !important;
|
||||
}
|
||||
.header {
|
||||
padding-left: 1rem;
|
||||
padding-right: 1rem;
|
||||
border-bottom: 1px solid #474747;
|
||||
}
|
||||
|
||||
@media (min-width: 640px){
|
||||
.header {
|
||||
padding-left: 16px;
|
||||
padding-right: 16px;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
</style>
|
||||
|
||||
{{ with .OutputFormats.Get "rss" -}}
|
||||
|
||||
@@ -1,8 +1,14 @@
|
||||
<nav style="background-color: #151515; padding-left: 20px">
|
||||
<nav
|
||||
style="
|
||||
background-color: #070707;
|
||||
padding-left: 20px;
|
||||
border-right: 1px solid #474747;
|
||||
"
|
||||
>
|
||||
{{ partial "search" . }}
|
||||
|
||||
<section class="gdoc-nav--main">
|
||||
<h2 style="font-weight: bold">NAVIGATION</h2>
|
||||
<div style="font-weight: bold; color: #5a5a5a">NAVIGATION</div>
|
||||
{{ if .Site.Params.GeekdocMenuBundle }} {{ partial "menu-bundle" (dict
|
||||
"current" . "source" .Site.Data.menu.main.main) }} {{ else }} {{ partial
|
||||
"menu-filetree" . }} {{ end }}
|
||||
@@ -10,7 +16,7 @@
|
||||
|
||||
<section class="gdoc-nav--more">
|
||||
{{ if .Site.Data.menu.more.more }}
|
||||
<h2 style="font-weight: bold">MORE</h2>
|
||||
<div style="font-weight: bold; color: #5a5a5a">MORE</div>
|
||||
{{ partial "menu-bundle" (dict "current" . "source"
|
||||
.Site.Data.menu.more.more) }} {{ end }}
|
||||
</section>
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
|
||||
{{ $showBreadcrumb := (and (default true .Page.Params.GeekdocBreadcrumb) (default true .Site.Params.GeekdocBreadcrumb)) }}
|
||||
{{ $showEdit := (and ($.Scratch.Get "geekdocFilePath") $geekdocRepo $geekdocEditPath) }}
|
||||
<div style="background: #151515;border-radius: 8px; margin-top: 29px;" class="gdoc-page__header flex flex-wrap
|
||||
<div style="background: #070707;border: 1px solid #404040;border-radius: 4px; margin-top: 29px;" class="gdoc-page__header flex flex-wrap
|
||||
{{ if $showBreadcrumb }} justify-between {{ else }} justify-end {{ end }}
|
||||
{{ if not $showEdit }} hidden-mobile {{ end }}
|
||||
{{ if (and (not $showBreadcrumb) (not $showEdit)) }} hidden {{ end }}" itemprop="breadcrumb">
|
||||
|
||||
@@ -2,22 +2,24 @@
|
||||
<div
|
||||
class="gdoc-search"
|
||||
style="
|
||||
background: #373737;
|
||||
border-radius: 8px;
|
||||
border: 1px solid #5a5a5a;
|
||||
background: #070707;
|
||||
border-radius: 4px;
|
||||
padding: 0.5rem;
|
||||
padding-left: 2rem;
|
||||
padding-right: 2rem;
|
||||
margin-top: 30px;
|
||||
margin-bottom: 30px;
|
||||
height: 33px;
|
||||
height: 37.9px;
|
||||
color: white;
|
||||
"
|
||||
>
|
||||
<svg class="icon gdoc_search"><use xlink:href="#gdoc_search"></use></svg>
|
||||
<input
|
||||
type="text"
|
||||
id="gdoc-search-input"
|
||||
style="all: unset"
|
||||
placeholder="Search..."
|
||||
style="all: unset; margin-top: 2px"
|
||||
placeholder="Search"
|
||||
aria-label="Search"
|
||||
maxlength="64"
|
||||
/>
|
||||
@@ -25,7 +27,11 @@
|
||||
<ul
|
||||
id="gdoc-search-results"
|
||||
class="gdoc-search__list"
|
||||
style="background-color: #373737; border-radius: 8px"
|
||||
style="
|
||||
background-color: #070707;
|
||||
border-radius: 4px;
|
||||
border: 1px solid #ffffff;
|
||||
"
|
||||
></ul>
|
||||
</div>
|
||||
{{ end }}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<footer class="gdoc-footer" style="background-color: #151515">
|
||||
<footer class="gdoc-footer" style="background-color: #070707">
|
||||
<div class="container flex">
|
||||
<div class="flex flex-wrap">
|
||||
<span class="gdoc-footer__item gdoc-footer__item--row">
|
||||
@@ -6,12 +6,12 @@
|
||||
<a
|
||||
href="https://gohugo.io/"
|
||||
class="gdoc-footer__link"
|
||||
style="color: #21cd9b"
|
||||
style="color: white"
|
||||
>Hugo</a
|
||||
>
|
||||
and
|
||||
<svg class="icon gdoc_heart">
|
||||
<use xlink:href="#gdoc_heart" fill="#21cd9b"></use>
|
||||
<use xlink:href="#gdoc_heart" fill="white"></use>
|
||||
</svg>
|
||||
</span>
|
||||
{{ with .Site.Params.GeekdocLegalNotice }}
|
||||
@@ -34,9 +34,9 @@
|
||||
style="text-decoration: none"
|
||||
>
|
||||
<svg class="icon gdoc_keyborad_arrow_up">
|
||||
<use xlink:href="#gdoc_keyborad_arrow_up" fill="#21cd9b"></use>
|
||||
<use xlink:href="#gdoc_keyborad_arrow_up" fill="white"></use>
|
||||
</svg>
|
||||
<span class="hidden-mobile" style="color: #21cd9b">Back to top</span>
|
||||
<span class="hidden-mobile" style="color: white">Back to top</span>
|
||||
</a>
|
||||
</span>
|
||||
</div>
|
||||
|
||||
@@ -1,5 +1,13 @@
|
||||
<header style="background-color: #000">
|
||||
<div class="container flex align-center justify-between">
|
||||
<header
|
||||
class="header"
|
||||
style="
|
||||
display: flex;
|
||||
align-items: center;
|
||||
height: 80px;
|
||||
background-image: linear-gradient(to right, #062d5d, #000000);
|
||||
"
|
||||
>
|
||||
<div class="flex align-center justify-between" style="width: 100%">
|
||||
{{ if .MenuEnabled }}
|
||||
<label for="menu-control" class="gdoc-nav__control">
|
||||
<svg class="icon gdoc_menu"><use xlink:href="#gdoc_menu"></use></svg>
|
||||
@@ -8,16 +16,38 @@
|
||||
</svg>
|
||||
</label>
|
||||
{{ end }}
|
||||
<a class="gdoc-header__link" href="{{ .Root.Site.BaseURL }}">
|
||||
<a
|
||||
target="_blank"
|
||||
rel="noreferrer noopener"
|
||||
style="margin-left: 10px"
|
||||
class="gdoc-header__link"
|
||||
href="https://openbb.co"
|
||||
>
|
||||
<span class="gdoc-brand flex align-center">
|
||||
<img class="gdoc-brand__img" src="{{ (default "brand.svg"
|
||||
.Root.Site.Params.GeekdocLogo) | relURL }}" alt="">
|
||||
<span class="gdoc-brand__title">{{ .Root.Site.Title }}</span>
|
||||
.Root.Site.Params.GeekdocLogo) | relURL }}" alt="" style="all: unset
|
||||
!important;">
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<span id="gdoc-dark-mode"> </span>
|
||||
<a href="https://openbb.co/products/terminal" class="_btn" target="_blank" rel="noopener noreferrer"
|
||||
>Install the OpenBB Terminal</a>
|
||||
<div>
|
||||
<a
|
||||
style="font-size: 14px; margin-right: 20px"
|
||||
href="https://openbb.co/"
|
||||
class="navlink _hide-on-mobile"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>Go to main website</a
|
||||
>
|
||||
<a
|
||||
style="font-size: 14px; height: 40px"
|
||||
href="https://openbb.co/products/terminal"
|
||||
class="_btn"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>Install the OpenBB Terminal</a
|
||||
>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
</header>
|
||||
|
||||
@@ -280,7 +280,7 @@ code {
|
||||
--body-font-color: #343a40;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #7749bf;
|
||||
--code-background: #f5f6f8;
|
||||
--code-accent-color: #e3e7eb;
|
||||
@@ -753,7 +753,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1098,7 +1098,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1443,7 +1443,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1997,8 +1997,8 @@ img {
|
||||
.gdoc-search__entry.is-active,
|
||||
.gdoc-search__entry:hover {
|
||||
text-decoration: underline;
|
||||
-webkit-text-decoration-style: dashed !important;
|
||||
text-decoration-style: dashed !important;
|
||||
-webkit-text-decoration-style: underline !important;
|
||||
text-decoration-style: underline !important;
|
||||
}
|
||||
.gdoc-nav__entry:visited,
|
||||
.gdoc-search__entry:visited {
|
||||
|
||||
@@ -277,7 +277,7 @@ code {
|
||||
--body-font-color: #343a40;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #7749bf;
|
||||
--code-background: #f5f6f8;
|
||||
--code-accent-color: #e3e7eb;
|
||||
@@ -736,7 +736,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1081,7 +1081,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1426,7 +1426,7 @@ code {
|
||||
--body-font-color: #ced3d8;
|
||||
--button-background: #498bcb;
|
||||
--button-border-color: #4186c9;
|
||||
--link-color: #21cd9b;
|
||||
--link-color: white;
|
||||
--link-color-visited: #ba8ef0;
|
||||
--code-background: #2f353a;
|
||||
--code-accent-color: #262b2f;
|
||||
@@ -1980,8 +1980,8 @@ img {
|
||||
.gdoc-search__entry.is-active,
|
||||
.gdoc-search__entry:hover {
|
||||
text-decoration: underline;
|
||||
-webkit-text-decoration-style: dashed !important;
|
||||
text-decoration-style: dashed !important;
|
||||
-webkit-text-decoration-style: underline !important;
|
||||
text-decoration-style: underline !important;
|
||||
}
|
||||
.gdoc-nav__entry:visited,
|
||||
.gdoc-search__entry:visited {
|
||||
|
||||
Reference in New Issue
Block a user