mirror of
https://github.com/RyanGreenup/cadmus.git
synced 2025-05-01 06:59:15 +02:00
921 lines
29 KiB
HTML
921 lines
29 KiB
HTML
|
|
|
|
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="assets/images/favicon.png">
|
|
<meta name="generator" content="mkdocs-1.1.2, mkdocs-material-5.3.2">
|
|
|
|
|
|
|
|
<title>Cadmus; Note-taking in the terminal</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="assets/stylesheets/main.fe0cca5b.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
|
|
<style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="css/SpaceMacsNotableFirst.css">
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
<body dir="ltr">
|
|
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#cadmus" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
<nav class="md-header-nav md-grid" aria-label="Header">
|
|
<a href="." title="Cadmus" class="md-header-nav__button md-logo" aria-label="Cadmus">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
|
|
|
|
</a>
|
|
<label class="md-header-nav__button md-icon" for="__drawer">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
|
|
</label>
|
|
<div class="md-header-nav__title" data-md-component="header-title">
|
|
|
|
<div class="md-header-nav__ellipsis">
|
|
<span class="md-header-nav__topic md-ellipsis">
|
|
Cadmus
|
|
</span>
|
|
<span class="md-header-nav__topic md-ellipsis">
|
|
|
|
Cadmus; Note-taking in the terminal
|
|
|
|
</span>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<label class="md-header-nav__button md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
</label>
|
|
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active">
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
|
|
<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>
|
|
</label>
|
|
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
|
|
</button>
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</nav>
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href="." title="Cadmus" class="md-nav__button md-logo" aria-label="Cadmus">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
|
|
|
|
</a>
|
|
Cadmus
|
|
</label>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
<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>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
<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>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!---
|
|
## 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">¶</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">¶</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">¶</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">¶</a></h2>
|
|
<h3 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">¶</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>To remove it it is sufficient to perform:
|
|
<div class="highlight"><pre><span></span><code>rm -rf <span class="s2">"</span><span class="nv">$HOME</span><span class="s2">/.cadmus"</span>
|
|
rm ~/.local/bin/cadmus
|
|
</code></pre></div></p>
|
|
</div>
|
|
<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">¶</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">¶</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">¶</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">¶</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">¶</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&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">'pcre2'</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">¶</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">¶</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">¶</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">'</span>
|
|
<span class="s1">export PATH="$HOME/.local/bin:$PATH"</span>
|
|
<span class="s1">export PATH="$HOME/.cargo/bin:$PATH"</span>
|
|
<span class="s1">'</span> >> ~/.bashrc
|
|
|
|
<span class="c1">## zsh</span>
|
|
<span class="nb">echo</span> <span class="s1">'</span>
|
|
<span class="s1">export PATH="$HOME/.local/bin:$PATH"</span>
|
|
<span class="s1">export PATH="$HOME/.cargo/bin:$PATH"</span>
|
|
<span class="s1">'</span> >> ~/.bashrc
|
|
|
|
<span class="c1">## fish</span>
|
|
|
|
<span class="nb">echo</span> <span class="s1">'</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 "$HOME/.cargo/bin $PATH</span>
|
|
<span class="s1">'</span> >> ~/.config/fish/config.fish
|
|
</code></pre></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
|
|
|
|
<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">
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
|
|
<script src="assets/javascripts/vendor.d710d30a.min.js"></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.9b3611bd.min.js"
|
|
}, typeof search !== "undefined" && search)
|
|
})
|
|
</script>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML"></script>
|
|
|
|
|
|
</body>
|
|
</html> |