1
0
mirror of https://github.com/RyanGreenup/cadmus.git synced 2025-08-19 04:12:16 +02:00

Fixed Incorrect Titles

This commit is contained in:
ryangreenup
2020-07-24 21:06:41 +10:00
parent 161d9fea65
commit b05f48af4e
16 changed files with 1021 additions and 93 deletions

View File

@@ -2,7 +2,7 @@
title: Convert
---
# Search
# Convert
!!! note
Start this with `cadmus convert`

View File

@@ -2,7 +2,7 @@
title: Export
---
# Search
# Export
!!! note
Start this with `cadmus export`

View File

@@ -33,6 +33,16 @@ Pressing Enter on a note will open it in the default app, [^1] if you want to do
[^2]: TODO: this only works on Xorg at the moment
[^3]: This is really good for *Zulip* / *Discord*
## When Would This Be Used
Imagine you're sitting at your desk and you forgot how to pipe with *Mathematica*, you're solution is `cadmus find` and then type something like `computer algebra` then <kbd>Ctrl</kbd>-<kbd>Q</kbd> `->`.
![](./media/How-To-Find.gif)
### Example
## How does it Work
So essentially this just uses ~skim~ and ~bat~ to filter/preview the notes, the interactive command is used with ~ripgrep~ and piping (that took me forever to figure out!!) to highlight the match in the preview.[^4] This is the code that achieves it:
@@ -69,8 +79,3 @@ sk --ansi -m -c 'rg -l -t markdown --ignore-case "{}"' \
```
[^4]: This highlighting works with both ~bat~ and *MDCat*, I prefer *MDCat* but there is a bug with footnotes preventing me from being able to use it right at the moment.
## When Would This Be Used
Imagine you're sitting at your desk and all of a sudden you're required to, I don't know, solve a linear recurrence relation, you're solution is `cadmus find` and then type something like `math mod` then <kbd>Ctrl</kbd>-<kbd>Q</kbd> linear.

View File

@@ -2,10 +2,21 @@
title: Cadmus; Note-taking in the terminal
---
<!---
## What does it do
## How Do I use it
### Keyboard Shortcuts
## How does it Work
## When Would This Be Used
-->
# Cadmus!
Cadmus is a knowledge management tool in your terminal.
![](./media/Many_Examples.png){: style="height:350px"}
## What does it do
Cadmus provides command driven interface to find and edit Markdown files, such as finding by name, searching for terms, filtering by tags, generating backlinks and generating relative links to other notes.

View File

@@ -2,7 +2,7 @@
title: Preview
---
# Search
# Preview
!!! note
Start this with `cadmus preview`

View File

@@ -2,7 +2,7 @@
title: Filter
---
# Search
# Filter
!!! note
Start this with `cadmus tags filter`