docs: Add chart docs

pull/116/head
Miguel Mota 3 years ago
parent 3c97b58e09
commit 2fe9991394
No known key found for this signature in database
GPG Key ID: 67EC1161588A00F9

@ -70,6 +70,9 @@ docs-server:
docs-deploy: docs
netlify deploy --prod
docs-open:
xdg-open "http://localhost:8080"
test:
go test ./...

@ -121,8 +121,6 @@ See [docs.cointop.sh/contributing](https://docs.cointop.sh/contributing)
Cointop has been mentioned in:
- [@Ubuntu Twitter](https://twitter.com/ubuntu/status/985947962311311360?lang=en)
- [Ubuntu Podcast](https://ubuntupodcast.org/2018/04/12/s11e06-six-feet-over-it/)
- [Ubuntu Facebook](https://www.facebook.com/ubuntulinux/photos/coin-tracking-for-hackers-cointop-is-a-fast-and-easy-to-use-command-line-applica/10156147393253592/)
- [Terminals Are Sexy](https://github.com/k4m4/terminals-are-sexy#tools-and-plugins)
- [The Changelog News](https://changelog.com/news/cointop-coin-tracking-for-hackers-rAzZ)

@ -0,0 +1,36 @@
---
title: "Chart"
date: 2020-01-01T00:00:00-00:00
draft: false
---
# Chart
The default chart shown is the global market cap of all cryptocurrencies.
Press <kbd>Enter</kbd> to toggle the price chart for the highlighted coin.
## Date ranges
Supported date ranges are `All Time`, `YTD`, `1Y`, `6M`, `3M`, `1M`, `7D`, `3D`, `24H`.
<sup><sub>YTD = Year-to-date<sub></sup>
To cycle through the date ranges:
Press <kbd>]</kbd> to cycle to the next date range.
Press <kbd>[</kbd> to cycle to the previous date range.
Press <kbd>{</kbd> to select the first date range.
Press <kbd>}</kbd> to selected the last date range.
## Size
Press <kbd>Ctrl</kbd>+<kbd>j</kbd> to increase the chart height.
Press <kbd>Ctrl</kbd>+<kbd>k</kbd> to decrease the chart height.
## Hide chart
Run cointop with the `--hide-chart` flag to always keep the chart hidden.

@ -119,7 +119,7 @@ draft: false
## How do I exit search?
Press <kbd>ESC</kbd> to exit search.
Press <kbd>Esc</kbd> to exit search.
## Does this work on the Raspberry Pi?
@ -139,7 +139,7 @@ draft: false
## What does the yellow asterisk in the row mean?
The yellow asterisk or star means that you've selected that coin to be a favorite.
The yellow asterisk `*` star means that you've selected that coin to be a favorite.
## My favorites aren't being saved?
@ -250,6 +250,12 @@ draft: false
<sup><sub>YTD = Year-to-date<sub></sup>
## How do I expand or shorten the chart?
Press <kbd>Ctrl</kbd>+<kbd>j</kbd> to increase the chart height.
Press <kbd>Ctrl</kbd>+<kbd>k</kbd> to decrease the chart height.
## How do I change the fiat currency?
Press <kbd>c</kbd> to show the currency convert menu, and press the corresponding key to select that as the fiat currency.

@ -0,0 +1,22 @@
---
title: "Favorites"
date: 2020-01-01T00:00:00-00:00
draft: false
---
# Favorites
## View favorites
To view your portfolio, press <kbd>F</kbd> (Shift+f)
## Exit favorites
To exit out of the portfolio view press, <kbd>F</kbd> (Shift+f) again or <kbd>q</kbd> or <kbd>Esc</kbd>
## Add favorite
To add a coin to your favorites, press <kbd>f</kbd> or <kbd>Space</kbd> on the highlighted coin to favorite. Favorited coins are marked with an `*` asterisk.
## Remove favorite
To remove a coin from your favorites, press <kbd>f</kbd> or <kbd>Space</kbd> on the favorited highlighted coin to unfavorite.

@ -13,7 +13,7 @@ To view your portfolio, press <kbd>P</kbd> (Shift+p)
## Exit portfolio
To exit out of the portfolio view press, <kbd>P</kbd> (Shift+p) again or <kbd>q</kbd> or <kbd>ESC</kbd>
To exit out of the portfolio view press, <kbd>P</kbd> (Shift+p) again or <kbd>q</kbd> or <kbd>Esc</kbd>
## Add entry

@ -0,0 +1,10 @@
---
title: "Searching"
date: 2020-01-01T00:00:00-00:00
draft: false
---
# Searching
To search for coins, press <kbd>/</kbd> to bring up the search prompt. Enter the search query and then hit <kbd>Enter</kbd> to submit. The coin that matches closes to the query will be highlighted.
Press <kbd>Esc</kbd> to exit the search prompt.

@ -3,7 +3,10 @@
<li><a href="/install">Install</a></li>
<li><a href="/update">Update</a></li>
<li><a href="/getting-started">Getting started</a></li>
<li><a href="/favorites">Favorites</a></li>
<li><a href="/portfolio">Portfolio</a></li>
<li><a href="/searching">Searching</a></li>
<li><a href="/chart">Chart</a></li>
<li><a href="/colorschemes">Colorschemes</a></li>
<li><a href="/shortcuts">Shortcuts</a></li>
<li><a href="/config">Config</a></li>

Loading…
Cancel
Save