mirror/cadmus
1
0
Fork 0
mirror of https://github.com/RyanGreenup/cadmus.git synced 2025-01-16 20:28:31 +01:00
Code Issues Releases Wiki Activity

Fixed Incorrect Titles

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Convert.md
View File

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

2
docs/Export.md
View File

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

15
docs/find.md
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.

11
docs/index.md
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.

2
docs/preview.md
View File

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

2
docs/tags/Filter.md
View File

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

1
mkdocs.yml
View File

@ -12,6 +12,7 @@ extra_css:
- css/SpaceMacsNotableFirst.css
#- css/dracula.css
markdown_extensions:
- attr_list
- codehilite:
linenums: false
- toc:

268
site/404.html
View File

@ -11,7 +11,7 @@
<link rel="shortcut icon" href="/assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-5.4.0">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-5.3.2">
@ -148,12 +148,270 @@
<li class="md-nav__item">
<a href="/index.html" title="Cadmus!" class="md-nav__link">
Cadmus!
<a href="/index.html" title="What does it do" class="md-nav__link">
What does it do
</a>
</li>
<li class="md-nav__item">
<a href="/Convert.html" title="Search" class="md-nav__link">
Search
</a>
</li>
<li class="md-nav__item">
<a href="/Export.html" title="Search" class="md-nav__link">
Search
</a>
</li>
<li class="md-nav__item">
<a href="/find.html" title="Find" class="md-nav__link">
Find
</a>
</li>
<li class="md-nav__item">
<a href="/preview.html" title="Search" class="md-nav__link">
Search
</a>
</li>
<li class="md-nav__item">
<a href="/search.html" title="Search" class="md-nav__link">
Search
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
<label class="md-nav__link" for="nav-7">
Misc
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M8.59 16.58L13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"/></svg>
</span>
</label>
<nav class="md-nav" aria-label="Misc" data-md-level="1">
<label class="md-nav__title" for="nav-7">
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</span>
Misc
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="/Misc/Summary-Misc.html" title="Summary" class="md-nav__link">
Summary
</a>
</li>
<li class="md-nav__item">
<a href="/Misc/windows.html" title="Windows" class="md-nav__link">
Windows
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
<label class="md-nav__link" for="nav-8">
Tools
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M8.59 16.58L13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"/></svg>
</span>
</label>
<nav class="md-nav" aria-label="Tools" data-md-level="1">
<label class="md-nav__title" for="nav-8">
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</span>
Tools
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="/Tools/New.html" title="New Note" class="md-nav__link">
New Note
</a>
</li>
<li class="md-nav__item">
<a href="/tools/BackLinks.html" title="Display Back Links" class="md-nav__link">
Display Back Links
</a>
</li>
<li class="md-nav__item">
<a href="/tools/New.html" title="New Note" class="md-nav__link">
New Note
</a>
</li>
<li class="md-nav__item">
<a href="/tools/Summary.html" title="Summary" class="md-nav__link">
Summary
</a>
</li>
<li class="md-nav__item">
<a href="/tools/webtitle.html" title="Print Web Title" class="md-nav__link">
Print Web Title
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
<label class="md-nav__link" for="nav-9">
Tags
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M8.59 16.58L13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"/></svg>
</span>
</label>
<nav class="md-nav" aria-label="Tags" data-md-level="1">
<label class="md-nav__title" for="nav-9">
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</span>
Tags
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="/tags/Filter.html" title="Filter" class="md-nav__link">
Filter
</a>
</li>
<li class="md-nav__item">
<a href="/tags/create.html" title="Create" class="md-nav__link">
Create
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
@ -197,14 +455,14 @@
</div>
<script src="/assets/javascripts/vendor.d710d30a.min.js"></script>
<script src="/assets/javascripts/bundle.b39636ac.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents"}</script>
<script src="/assets/javascripts/bundle.7f4f3c92.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents"}</script>
<script>
app = initialize({
base: "/",
features: [],
search: Object.assign({
worker: "/assets/javascripts/worker/search.a68abb33.min.js"
worker: "/assets/javascripts/worker/search.9b3611bd.min.js"
}, typeof search !== "undefined" && search)
})
</script>

2
site/assets/javascripts/bundle.b39636ac.min.js vendored
View File

File diff suppressed because one or more lines are too long

1
site/assets/javascripts/bundle.b39636ac.min.js.map
View File

File diff suppressed because one or more lines are too long

59
site/assets/javascripts/worker/search.a68abb33.min.js vendored
View File

File diff suppressed because one or more lines are too long

1
site/assets/javascripts/worker/search.a68abb33.min.js.map
View File

File diff suppressed because one or more lines are too long

690
site/index.html
View File

@ -11,11 +11,11 @@
<link rel="shortcut icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-5.4.0">
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-5.3.2">
<title>Cadmus! - Cadmus</title>
<title>Cadmus; Note-taking in the terminal</title>
@ -79,7 +79,7 @@
</span>
<span class="md-header-nav__topic md-ellipsis">
Cadmus!
Cadmus; Note-taking in the terminal
</span>
</div>
@ -161,10 +161,390 @@
<a href="index.html" title="Cadmus!" class="md-nav__link md-nav__link--active">
Cadmus!
<label class="md-nav__link md-nav__link--active" for="__toc">
What does it do
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 9h14V7H3v2m0 4h14v-2H3v2m0 4h14v-2H3v2m16 0h2v-2h-2v2m0-10v2h2V7h-2m0 6h2v-2h-2v2z"/></svg>
</span>
</label>
<a href="index.html" title="What does it do" class="md-nav__link md-nav__link--active">
What does it do
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</span>
Table of contents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#what-does-it-do" class="md-nav__link">
What does it do
</a>
</li>
<li class="md-nav__item">
<a href="#how-does-it-work" class="md-nav__link">
How does it Work
</a>
</li>
<li class="md-nav__item">
<a href="#how-do-i-use-it" class="md-nav__link">
How Do i Use It
</a>
<nav class="md-nav" aria-label="How Do i Use It">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
Installation
</a>
</li>
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
Usage
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#when-or-why-would-i-use-this" class="md-nav__link">
When or Why Would I Use This
</a>
</li>
<li class="md-nav__item">
<a href="#background" class="md-nav__link">
Background
</a>
</li>
<li class="md-nav__item">
<a href="#keyboard-bindings" class="md-nav__link">
keyboard bindings
</a>
</li>
<li class="md-nav__item">
<a href="#dependencies" class="md-nav__link">
Dependencies
</a>
<nav class="md-nav" aria-label="Dependencies">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#recommended-for-all-features" class="md-nav__link">
Recommended for all Features
</a>
</li>
<li class="md-nav__item">
<a href="#interesting-helpful-recommended-generally-not-strictly-necessary" class="md-nav__link">
Interesting / Helpful / Recommended Generally (Not strictly necessary)
</a>
</li>
<li class="md-nav__item">
<a href="#path" class="md-nav__link">
PATH
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="Convert.html" title="Search" class="md-nav__link">
Search
</a>
</li>
<li class="md-nav__item">
<a href="Export.html" title="Search" class="md-nav__link">
Search
</a>
</li>
<li class="md-nav__item">
<a href="find.html" title="Find" class="md-nav__link">
Find
</a>
</li>
<li class="md-nav__item">
<a href="preview.html" title="Search" class="md-nav__link">
Search
</a>
</li>
<li class="md-nav__item">
<a href="search.html" title="Search" class="md-nav__link">
Search
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
<label class="md-nav__link" for="nav-7">
Misc
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M8.59 16.58L13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"/></svg>
</span>
</label>
<nav class="md-nav" aria-label="Misc" data-md-level="1">
<label class="md-nav__title" for="nav-7">
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</span>
Misc
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="Misc/Summary-Misc.html" title="Summary" class="md-nav__link">
Summary
</a>
</li>
<li class="md-nav__item">
<a href="Misc/windows.html" title="Windows" class="md-nav__link">
Windows
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
<label class="md-nav__link" for="nav-8">
Tools
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M8.59 16.58L13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"/></svg>
</span>
</label>
<nav class="md-nav" aria-label="Tools" data-md-level="1">
<label class="md-nav__title" for="nav-8">
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</span>
Tools
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="Tools/New.html" title="New Note" class="md-nav__link">
New Note
</a>
</li>
<li class="md-nav__item">
<a href="tools/BackLinks.html" title="Display Back Links" class="md-nav__link">
Display Back Links
</a>
</li>
<li class="md-nav__item">
<a href="tools/New.html" title="New Note" class="md-nav__link">
New Note
</a>
</li>
<li class="md-nav__item">
<a href="tools/Summary.html" title="Summary" class="md-nav__link">
Summary
</a>
</li>
<li class="md-nav__item">
<a href="tools/webtitle.html" title="Print Web Title" class="md-nav__link">
Print Web Title
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
<label class="md-nav__link" for="nav-9">
Tags
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M8.59 16.58L13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"/></svg>
</span>
</label>
<nav class="md-nav" aria-label="Tags" data-md-level="1">
<label class="md-nav__title" for="nav-9">
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</span>
Tags
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="tags/Filter.html" title="Filter" class="md-nav__link">
Filter
</a>
</li>
<li class="md-nav__item">
<a href="tags/create.html" title="Create" class="md-nav__link">
Create
</a>
</li>
</ul>
</nav>
</li>
@ -185,6 +565,112 @@
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
</span>
Table of contents
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#what-does-it-do" class="md-nav__link">
What does it do
</a>
</li>
<li class="md-nav__item">
<a href="#how-does-it-work" class="md-nav__link">
How does it Work
</a>
</li>
<li class="md-nav__item">
<a href="#how-do-i-use-it" class="md-nav__link">
How Do i Use It
</a>
<nav class="md-nav" aria-label="How Do i Use It">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
Installation
</a>
</li>
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
Usage
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#when-or-why-would-i-use-this" class="md-nav__link">
When or Why Would I Use This
</a>
</li>
<li class="md-nav__item">
<a href="#background" class="md-nav__link">
Background
</a>
</li>
<li class="md-nav__item">
<a href="#keyboard-bindings" class="md-nav__link">
keyboard bindings
</a>
</li>
<li class="md-nav__item">
<a href="#dependencies" class="md-nav__link">
Dependencies
</a>
<nav class="md-nav" aria-label="Dependencies">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#recommended-for-all-features" class="md-nav__link">
Recommended for all Features
</a>
</li>
<li class="md-nav__item">
<a href="#interesting-helpful-recommended-generally-not-strictly-necessary" class="md-nav__link">
Interesting / Helpful / Recommended Generally (Not strictly necessary)
</a>
</li>
<li class="md-nav__item">
<a href="#path" class="md-nav__link">
PATH
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
@ -199,17 +685,170 @@
<h1 id="cadmus">Cadmus!<a class="headerlink" href="#cadmus" title="Permanent link">&para;</a></h1>
<!---
## What does it do
## How Do I use it
### Keyboard Shortcuts
## How does it Work
## When Would This Be Used
-->
<h1 id="cadmus">Cadmus!<a class="headerlink" href="#cadmus" title="Permanent link">&para;</a></h1>
<p>Cadmus is a knowledge management tool in your terminal.</p>
<p><img alt="" src="media/Many_Examples.png" style="height:350px" /></p>
<h2 id="what-does-it-do">What does it do<a class="headerlink" href="#what-does-it-do" title="Permanent link">&para;</a></h2>
<p>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.</p>
<h2 id="how-does-it-work">How does it Work<a class="headerlink" href="#how-does-it-work" title="Permanent link">&para;</a></h2>
<p>Cadmus is just a bunch of shell scripts that essentially use pipes and <em>ripgrep</em> with <em>skim</em> to display them.</p>
<h2 id="how-do-i-use-it">How Do i Use It<a class="headerlink" href="#how-do-i-use-it" title="Permanent link">&para;</a></h2>
<h3 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h3>
<p><a href="https://aur.archlinux.org/packages/cadmus-notes/">cadmus is available on the AUR</a>, generally however cadmus will operate in a portable fashion from =~/.cadmus/=, so just using <code>git</code> is fine as well:</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span> <span class="k">$(</span>mktemp -d<span class="k">)</span>
wget https://raw.githubusercontent.com/RyanGreenup/cadmus/master/install.sh
bash install.sh
</code></pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Template</p>
<p>To remove it it is sufficient to perform:
<div class="highlight"><pre><span></span><code>rm -rf <span class="s2">&quot;</span><span class="nv">$HOME</span><span class="s2">/.cadmus&quot;</span>
rm ~/.local/bin/cadmus
</code></pre></div></p>
</div>
<h1 id="what-does-it-do">What does it do<a class="headerlink" href="#what-does-it-do" title="Permanent link">&para;</a></h1>
<h1 id="how-does-it-work">how does it work<a class="headerlink" href="#how-does-it-work" title="Permanent link">&para;</a></h1>
<h1 id="how-do-i-use-it">how do i use it<a class="headerlink" href="#how-do-i-use-it" title="Permanent link">&para;</a></h1>
<h1 id="when-or-why-would-i-use-this">when or why would i use this<a class="headerlink" href="#when-or-why-would-i-use-this" title="Permanent link">&para;</a></h1>
<h1 id="keyboard-bindings">keyboard bindings<a class="headerlink" href="#keyboard-bindings" title="Permanent link">&para;</a></h1>
<h1 id="tldr">tl;dr<a class="headerlink" href="#tldr" title="Permanent link">&para;</a></h1>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This assumes that <a href="#dependencies">the dependencies</a> have all been installed and <a href="https://www.lesbonscomptes.com/recoll/">recoll</a> is indexing the directory of your notes.</p>
</div>
<h3 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h3>
<p>Just run <sub>cadmus</sub> at the terminal and it will walk you through generating a config file. Afterwards running <sub>cadmus</sub> will show various commands such as find and search that can be used to work with your knowledge base.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Shortly functionality will be implemented to allow creating a <code>.cadmus</code> file in any directory that will act as a config for all markdown files beneath that directory, this is useful if you want to use cadmus with documentation for a project and still have access to your notes, or have multiple knowledge bases.</p>
</div>
<h2 id="when-or-why-would-i-use-this">When or Why Would I Use This<a class="headerlink" href="#when-or-why-would-i-use-this" title="Permanent link">&para;</a></h2>
<p>Well I wrote this because my interests are Math and Data Sci and quite frankly I suffer from information overload, I like open-source stuff, simple scripts and unix philosophy so if any of that resonates with you try it out.</p>
<p>This is all modular so take what you like and reimplement it, fork it, make PR's and please fell free to post issues even if it's just to say <em>Hey, I like tool x have you tried it before?</em>.</p>
<h2 id="background">Background<a class="headerlink" href="#background" title="Permanent link">&para;</a></h2>
<p>The idea of cadmus is to demonstrate how powerful the terminal can be and how it
can act as a functional replacement for tools like OneNote or Evernote.</p>
<p>In reality <em>Cadmus</em> is just a couple of shell scripts to help users tie together other really good tools like <em>Skim</em>, <em>ripgrep</em>, <em>recoll</em> and <em>TMSU</em>.</p>
<h2 id="keyboard-bindings">keyboard bindings<a class="headerlink" href="#keyboard-bindings" title="Permanent link">&para;</a></h2>
<table>
<thead>
<tr>
<th>Command</th>
<th>Shortcut</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cadmus find</code></td>
<td><kbd>Ctrl</kbd>-<kbd>Q</kbd></td>
<td>switch between find and grep in skim</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<h2 id="dependencies">Dependencies<a class="headerlink" href="#dependencies" title="Permanent link">&para;</a></h2>
<!---
This was a dependency but I switched to java script
- [R](https://en.wikipedia.org/wiki/R_(programming_language))
-->
<ul>
<li><a href="https://github.com/sharkdp/bat">bat</a></li>
<li><a href="https://www.gnu.org/software/coreutils/manual/html_node/The-cut-command.html">cut</a></li>
<li><a href="https://github.com/sharkdp/fd">fd</a></li>
<li><a href="https://man7.org/linux/man-pages/man1/find.1.html">find</a></li>
<li><a href="https://github.com/junegunn/fzf">fzf</a></li>
<li><a href="https://www.gnu.org/software/coreutils/manual/html_node/realpath-invocation.html#realpath-invocation">GNU realpath</a></li>
<li><a href="https://www.gnu.org/software/grep/">grep</a></li>
<li><a href="https://www.archlinux.org/packages/community/x86_64/highlight/">highlight</a></li>
<li>jq <sup> <a href="https://www.archlinux.org/packages/community/x86_64/jq/">Arch</a> | <a href="https://formulae.brew.sh/formula/jq#default">brew</a> | <a href="https://packages.ubuntu.com/search?keywords=jq">ubuntu</a> </sup></li>
<li><a href="https://aur.archlinux.org/packages/mdcat/">mdcat</a><sup>AUR</sup></li>
<li><a href="https://nodejs.org/en/">node</a></li>
<li><a href="https://github.com/jgm/pandoc">Pandoc</a></li>
<li><a href="https://wiki.archlinux.org/index.php/Perl">perl</a></li>
<li><a href="https://www.python.org/download/releases/3.0/">python</a></li>
<li><a href="https://www.archlinux.org/packages/community/any/ranger/">ranger</a></li>
<li><a href="https://www.archlinux.org/packages/extra/x86_64/recode/">recode</a></li>
<li><a href="https://www.lesbonscomptes.com/recoll/">Recoll</a></li>
<li>
<p><a href="https://www.google.com/search?client=firefox-b-d&amp;q=ripgrep+github">rg</a></p>
<ul>
<li>Make sure to include <code>pcre2</code>, this comes in <em>Arch</em>, if using <code>cargo</code>:
<div class="highlight"><pre><span></span><code>cargo install ripgrep --features <span class="s1">&#39;pcre2&#39;</span>
</code></pre></div></li>
</ul>
</li>
<li>
<p><a href="https://github.com/chmln/sd">sd</a></p>
</li>
<li><a href="https://www.gnu.org/software/sed/">sed</a></li>
<li><a href="https://github.com/lotabout/skim">skim</a></li>
<li><a href="https://aur.archlinux.org/packages/tmsu/">tmsu</a><sup>AUR</sup></li>
<li><a href="https://www.archlinux.org/packages/extra/x86_64/xclip/">xclip</a> or <a href="https://github.com/bugaevc/wl-clipboard">wl-clipboard</a></li>
</ul>
<h3 id="recommended-for-all-features">Recommended for all Features<a class="headerlink" href="#recommended-for-all-features" title="Permanent link">&para;</a></h3>
<ul>
<li><a href="https://jlk.fjfi.cvut.cz/arch/manpages/man/ip.8">iproute2</a> (for the ip binary)<ul>
<li>if you're on mac <a href="https://superuser.com/a/898971">this stackExchange</a> answer suggests <a href="https://formulae.brew.sh/formula/iproute2mac#default">iproute2</a> may work</li>
</ul>
</li>
<li>tectonic</li>
<li>texlive</li>
<li><a href="https://sw.kovidgoyal.net/kitty/">Kitty</a> <ul>
<li>I've also heard good things about <a href="https://www.iterm2.com/">iterm2</a></li>
</ul>
</li>
<li><a href="https://pypi.org/project/mkdocs-material-extensions/">MkDocs</a><ul>
<li><a href="https://pypi.org/project/mkdocs-material-extensions/">MkDocs Material Extensions</a></li>
<li><a href="https://github.com/squidfunk/mkdocs-material">MkDocs Material Theme</a></li>
</ul>
</li>
<li><a href="https://neovim.io/">nvim</a></li>
<li><a href="https://tectonic-typesetting.github.io/en-US/">tectonic</a></li>
<li><a href="https://aur.archlinux.org/packages/python-weasyprint/">WeasyPrint</a></li>
</ul>
<h3 id="interesting-helpful-recommended-generally-not-strictly-necessary">Interesting / Helpful / Recommended Generally (Not strictly necessary)<a class="headerlink" href="#interesting-helpful-recommended-generally-not-strictly-necessary" title="Permanent link">&para;</a></h3>
<ul>
<li><a href="http://guake-project.org/">guake</a> or <a href="https://kde.org/applications/en/system/org.kde.yakuake">yakuake</a></li>
<li><a href="https://github.com/marktext/marktext">MarkText</a></li>
<li>mdless</li>
<li><a href="https://gitlab.com/gardenappl/readability-cli">readability-cli</a></li>
<li><a href="https://github.com/tamlok/vnote">VNote</a></li>
<li>VSCode</li>
</ul>
<h3 id="path">PATH<a class="headerlink" href="#path" title="Permanent link">&para;</a></h3>
<p>If any dependencies are installed with <code>pip</code> or <code>cargo</code> it will be necessary to add these directories to your <code>PATH</code>:</p>
<div class="highlight"><pre><span></span><code><span class="c1">## bash</span>
<span class="nb">echo</span> <span class="s1">&#39;</span>
<span class="s1">export PATH=&quot;$HOME/.local/bin:$PATH&quot;</span>
<span class="s1">export PATH=&quot;$HOME/.cargo/bin:$PATH&quot;</span>
<span class="s1">&#39;</span> &gt;&gt; ~/.bashrc
<span class="c1">## zsh</span>
<span class="nb">echo</span> <span class="s1">&#39;</span>
<span class="s1">export PATH=&quot;$HOME/.local/bin:$PATH&quot;</span>
<span class="s1">export PATH=&quot;$HOME/.cargo/bin:$PATH&quot;</span>
<span class="s1">&#39;</span> &gt;&gt; ~/.bashrc
<span class="c1">## fish</span>
<span class="nb">echo</span> <span class="s1">&#39;</span>
<span class="s1">set PATH $HOME/.local/bin $PATH</span>
<span class="s1">set PATH $HOME/bin $PATH</span>
<span class="s1">set PATH &quot;$HOME/.cargo/bin $PATH</span>
<span class="s1">&#39;</span> &gt;&gt; ~/.config/fish/config.fish
</code></pre></div>
@ -225,6 +864,27 @@
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid" aria-label="Footer">
<a href="Convert.html" title="Search" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-footer-nav__title">
<div class="md-ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Search
</div>
</div>
<div class="md-footer-nav__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
@ -242,14 +902,14 @@
</div>
<script src="assets/javascripts/vendor.d710d30a.min.js"></script>
<script src="assets/javascripts/bundle.b39636ac.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents"}</script>
<script src="assets/javascripts/bundle.7f4f3c92.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents"}</script>
<script>
app = initialize({
base: ".",
features: [],
search: Object.assign({
worker: "assets/javascripts/worker/search.a68abb33.min.js"
worker: "assets/javascripts/worker/search.9b3611bd.min.js"
}, typeof search !== "undefined" && search)
})
</script>

2
site/search/search_index.json
View File

File diff suppressed because one or more lines are too long

56
site/sitemap.xml
View File

@ -3,5 +3,61 @@
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url><url>
<loc>None</loc>
<lastmod>2020-07-24</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
site/sitemap.xml.gz
View File

Binary file not shown.