From 2fe9991394b9b2a7226145fa88fadd878f944b63 Mon Sep 17 00:00:00 2001 From: Miguel Mota Date: Sun, 18 Apr 2021 19:38:41 -0700 Subject: [PATCH] docs: Add chart docs --- Makefile | 3 ++ README.md | 2 -- docs/content/chart.md | 36 +++++++++++++++++++ docs/content/faq.md | 10 ++++-- docs/content/favorites.md | 22 ++++++++++++ docs/content/portfolio.md | 2 +- docs/content/searching.md | 10 ++++++ .../partials/docs/inject/menu-before.html | 3 ++ 8 files changed, 83 insertions(+), 5 deletions(-) create mode 100644 docs/content/chart.md create mode 100644 docs/content/favorites.md create mode 100644 docs/content/searching.md diff --git a/Makefile b/Makefile index 3f1d16a..e26073a 100644 --- a/Makefile +++ b/Makefile @@ -70,6 +70,9 @@ docs-server: docs-deploy: docs netlify deploy --prod +docs-open: + xdg-open "http://localhost:8080" + test: go test ./... diff --git a/README.md b/README.md index 4ceef35..eb49503 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/docs/content/chart.md b/docs/content/chart.md new file mode 100644 index 0000000..c38bc26 --- /dev/null +++ b/docs/content/chart.md @@ -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 Enter 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`. + + YTD = Year-to-date + +To cycle through the date ranges: + + Press ] to cycle to the next date range. + + Press [ to cycle to the previous date range. + + Press { to select the first date range. + + Press } to selected the last date range. + +## Size + +Press Ctrl+j to increase the chart height. + +Press Ctrl+k to decrease the chart height. + +## Hide chart + +Run cointop with the `--hide-chart` flag to always keep the chart hidden. diff --git a/docs/content/faq.md b/docs/content/faq.md index 7f6608d..e57e052 100644 --- a/docs/content/faq.md +++ b/docs/content/faq.md @@ -119,7 +119,7 @@ draft: false ## How do I exit search? - Press ESC to exit search. + Press Esc 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 YTD = Year-to-date +## How do I expand or shorten the chart? + + Press Ctrl+j to increase the chart height. + + Press Ctrl+k to decrease the chart height. + ## How do I change the fiat currency? Press c to show the currency convert menu, and press the corresponding key to select that as the fiat currency. diff --git a/docs/content/favorites.md b/docs/content/favorites.md new file mode 100644 index 0000000..7d05d18 --- /dev/null +++ b/docs/content/favorites.md @@ -0,0 +1,22 @@ +--- +title: "Favorites" +date: 2020-01-01T00:00:00-00:00 +draft: false +--- +# Favorites + +## View favorites + +To view your portfolio, press F (Shift+f) + +## Exit favorites + +To exit out of the portfolio view press, F (Shift+f) again or q or Esc + +## Add favorite + +To add a coin to your favorites, press f or Space on the highlighted coin to favorite. Favorited coins are marked with an `*` asterisk. + +## Remove favorite + +To remove a coin from your favorites, press f or Space on the favorited highlighted coin to unfavorite. diff --git a/docs/content/portfolio.md b/docs/content/portfolio.md index 515c936..913be7f 100644 --- a/docs/content/portfolio.md +++ b/docs/content/portfolio.md @@ -13,7 +13,7 @@ To view your portfolio, press P (Shift+p) ## Exit portfolio -To exit out of the portfolio view press, P (Shift+p) again or q or ESC +To exit out of the portfolio view press, P (Shift+p) again or q or Esc ## Add entry diff --git a/docs/content/searching.md b/docs/content/searching.md new file mode 100644 index 0000000..43b59ae --- /dev/null +++ b/docs/content/searching.md @@ -0,0 +1,10 @@ +--- +title: "Searching" +date: 2020-01-01T00:00:00-00:00 +draft: false +--- +# Searching + +To search for coins, press / to bring up the search prompt. Enter the search query and then hit Enter to submit. The coin that matches closes to the query will be highlighted. + +Press Esc to exit the search prompt. diff --git a/docs/themes/hugo-book/layouts/partials/docs/inject/menu-before.html b/docs/themes/hugo-book/layouts/partials/docs/inject/menu-before.html index a76fb46..81f36cf 100644 --- a/docs/themes/hugo-book/layouts/partials/docs/inject/menu-before.html +++ b/docs/themes/hugo-book/layouts/partials/docs/inject/menu-before.html @@ -3,7 +3,10 @@
  • Install
  • Update
  • Getting started
    • +
  • Favorites
  • Portfolio
    • +
  • Searching
    • +
  • Chart
  • Colorschemes
  • Shortcuts
  • Config