Some docs improvements (#2528)

* some docs improvements

* small upd on link

* updated favicon

Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
This commit is contained in:
jose-donato
2022-09-12 12:45:57 +01:00
committed by GitHub
parent 3d0190e35b
commit 1bdaa03cdc
19 changed files with 32 additions and 10 deletions

1
website/config.toml vendored
View File

@@ -1,5 +1,6 @@
baseURL = "https://openbb-finance.github.io/OpenBBTerminal"
theme = "hugo-geekdoc"
title = "OpenBB Terminal Documentation"
# Required to get well formatted code blocks
pygmentsUseClasses = true

View File

@@ -7,7 +7,7 @@ financial terminal that will help you make more informed decisions, faster."
geekdocCollapseSection: true
---
## Introduction
**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
@@ -15,7 +15,7 @@ to make sense of raw unrefined data. Our mission is to make investment research
---
## The OpenBB Terminal is Free and Open-Source (FOSS)
**The OpenBB Terminal is Free and Open-Source (FOSS)**
<!-- markdownlint-capture -->
<!-- markdownlint-disable MD033 -->

View File

@@ -4,6 +4,10 @@ more:
ref: "https://openbb.co"
external: true
icon: "gdoc_link"
- name: "Go to Bot Docs"
ref: "https://my.openbb.co/app/docs"
external: true
icon: "gdoc_link"
- name: "Install the Terminal"
ref: "https://openbb.co/products/terminal"
external: true

View File

@@ -22,6 +22,19 @@ body {
font-family: 'Fira Code', sans-serif !important;
}
a {
color: #c8c8c8 !important;
text-decoration: underline !important;
}
a:hover {
color: #a2a2a2 !important
}
a:active {
color: #808080 !important
}
.container {
max-width: 97rem;
}

View File

@@ -30,7 +30,7 @@
{{ end }}
<span class="flex">
{{ if $icon }}<svg class="icon {{ .icon }}"><use xlink:href="#{{ .icon }}"></use></svg>{{ end }}
<a href="{{ if .external }}{{ .ref }}{{ else }}{{ relref $current .ref }}{{ end }}"
<a style="text-decoration: none !important;" href="{{ if .external }}{{ .ref }}{{ else }}{{ relref $current .ref }}{{ end }}"
class="gdoc-nav__entry {{ if not .external }}{{ if $isCurrent }}is-active{{ end }}{{ end }}">
{{ .name }}
</a>

View File

@@ -33,7 +33,11 @@
<span id="gdoc-dark-mode"> </span>
<div>
<a
style="font-size: 14px; margin-right: 20px"
style="
font-size: 14px;
margin-right: 20px;
text-decoration: none !important;
"
href="https://openbb.co/"
class="navlink _hide-on-mobile"
target="_blank"

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 1.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.2 KiB

After

Width:  |  Height:  |  Size: 1.8 KiB

View File

@@ -2,8 +2,8 @@
<browserconfig>
<msapplication>
<tile>
<square150x150logo src="/favicon/mstile-150x150.png"/>
<TileColor>#2f333e</TileColor>
<square150x150logo src="/mstile-150x150.png"/>
<TileColor>#da532c</TileColor>
</tile>
</msapplication>
</browserconfig>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 773 B

After

Width:  |  Height:  |  Size: 521 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 703 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.4 KiB

View File

@@ -3,17 +3,17 @@
"short_name": "",
"icons": [
{
"src": "/favicon/android-chrome-192x192.png",
"src": "/android-chrome-192x192.png",
"sizes": "192x192",
"type": "image/png"
},
{
"src": "/favicon/android-chrome-512x512.png",
"src": "/android-chrome-512x512.png",
"sizes": "512x512",
"type": "image/png"
}
],
"theme_color": "#2f333e",
"background_color": "#2f333e",
"theme_color": "#ffffff",
"background_color": "#ffffff",
"display": "standalone"
}