1265 lines
47 KiB
HTML
1265 lines
47 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" />
|
|
|
|
<meta
|
|
name="description"
|
|
content="Tools for a more conscious and free humanity"
|
|
/>
|
|
|
|
<meta name="author" content="aja" />
|
|
|
|
<link rel="next" href="./markdown/" />
|
|
|
|
<link rel="icon" href="./assets/images/favicon.png" />
|
|
<meta name="generator" content="zensical-0.0.43" />
|
|
|
|
<title>Welcome! - up</title>
|
|
|
|
<link
|
|
rel="stylesheet"
|
|
href="./assets/stylesheets/modern/main.fba56155.min.css"
|
|
/>
|
|
|
|
<link
|
|
rel="stylesheet"
|
|
href="./assets/stylesheets/modern/palette.dfe2e883.min.css"
|
|
/>
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
|
<link
|
|
rel="stylesheet"
|
|
href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,500,500i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback"
|
|
/>
|
|
<style>
|
|
:root {
|
|
--md-text-font: "Inter";
|
|
--md-code-font: "JetBrains Mono";
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
((__md_scope = new URL(".", location)),
|
|
__md_scope.pathname.endsWith("/") ||
|
|
(__md_scope = new URL(__md_scope.pathname + "/", location)),
|
|
(__md_hash = (e) =>
|
|
[...e].reduce((e, t) => (e << 5) - e + t.charCodeAt(0), 0)),
|
|
(__md_get = (e, t = localStorage, _ = __md_scope) =>
|
|
JSON.parse(t.getItem(_.pathname + "." + e))),
|
|
(__md_set = (e, t, _ = localStorage, a = __md_scope) => {
|
|
try {
|
|
_.setItem(a.pathname + "." + e, JSON.stringify(t));
|
|
} catch (e) {}
|
|
}),
|
|
document.documentElement.setAttribute(
|
|
"data-platform",
|
|
navigator.platform,
|
|
));
|
|
</script>
|
|
</head>
|
|
|
|
<body
|
|
dir="ltr"
|
|
data-md-color-scheme="default"
|
|
data-md-color-primary="indigo"
|
|
data-md-color-accent="indigo"
|
|
>
|
|
<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" aria-label="Navigation"></label>
|
|
<div data-md-component="skip">
|
|
<a href="#welcome" class="md-skip"> Skip to content </a>
|
|
</div>
|
|
<div data-md-component="announce"></div>
|
|
|
|
<header class="md-header md-header--shadow" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a
|
|
href=""
|
|
title="up"
|
|
class="md-header__button md-logo"
|
|
aria-label="up"
|
|
data-md-component="logo"
|
|
>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
stroke-width="2"
|
|
class="lucide lucide-book-open"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<path
|
|
d="M12 7v14M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"
|
|
/>
|
|
</svg>
|
|
</a>
|
|
<label
|
|
class="md-header__button md-icon"
|
|
for="__drawer"
|
|
aria-label="Navigation"
|
|
>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
stroke-width="2"
|
|
class="lucide lucide-menu"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<path d="M4 5h16M4 12h16M4 19h16" />
|
|
</svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis"> up </span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis"> Welcome! </span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<form class="md-header__option" data-md-component="palette">
|
|
<input
|
|
class="md-option"
|
|
data-md-color-media="none"
|
|
data-md-color-scheme="default"
|
|
data-md-color-primary="indigo"
|
|
data-md-color-accent="indigo"
|
|
aria-label="Switch to dark mode"
|
|
type="radio"
|
|
name="__palette"
|
|
id="__palette_0"
|
|
/>
|
|
|
|
<label
|
|
class="md-header__button md-icon"
|
|
title="Switch to dark mode"
|
|
for="__palette_1"
|
|
hidden
|
|
>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
stroke-width="2"
|
|
class="lucide lucide-sun"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<circle cx="12" cy="12" r="4" />
|
|
<path
|
|
d="M12 2v2M12 20v2M4.93 4.93l1.41 1.41M17.66 17.66l1.41 1.41M2 12h2M20 12h2M6.34 17.66l-1.41 1.41M19.07 4.93l-1.41 1.41"
|
|
/>
|
|
</svg>
|
|
</label>
|
|
|
|
<input
|
|
class="md-option"
|
|
data-md-color-media="none"
|
|
data-md-color-scheme="slate"
|
|
data-md-color-primary="indigo"
|
|
data-md-color-accent="indigo"
|
|
aria-label="Switch to light mode"
|
|
type="radio"
|
|
name="__palette"
|
|
id="__palette_1"
|
|
/>
|
|
|
|
<label
|
|
class="md-header__button md-icon"
|
|
title="Switch to light mode"
|
|
for="__palette_0"
|
|
hidden
|
|
>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
stroke-width="2"
|
|
class="lucide lucide-moon"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<path
|
|
d="M20.985 12.486a9 9 0 1 1-9.473-9.472c.405-.022.617.46.402.803a6 6 0 0 0 8.268 8.268c.344-.215.825-.004.803.401"
|
|
/>
|
|
</svg>
|
|
</label>
|
|
</form>
|
|
|
|
<script>
|
|
var palette = __md_get("__palette");
|
|
if (palette && palette.color) {
|
|
if ("(prefers-color-scheme)" === palette.color.media) {
|
|
var media = matchMedia("(prefers-color-scheme: light)"),
|
|
input = document.querySelector(
|
|
media.matches
|
|
? "[data-md-color-media='(prefers-color-scheme: light)']"
|
|
: "[data-md-color-media='(prefers-color-scheme: dark)']",
|
|
);
|
|
((palette.color.media = input.getAttribute(
|
|
"data-md-color-media",
|
|
)),
|
|
(palette.color.scheme = input.getAttribute(
|
|
"data-md-color-scheme",
|
|
)),
|
|
(palette.color.primary = input.getAttribute(
|
|
"data-md-color-primary",
|
|
)),
|
|
(palette.color.accent = input.getAttribute(
|
|
"data-md-color-accent",
|
|
)));
|
|
}
|
|
for (var [key, value] of Object.entries(palette.color))
|
|
document.body.setAttribute("data-md-color-" + key, value);
|
|
}
|
|
</script>
|
|
|
|
<label
|
|
class="md-header__button md-icon"
|
|
for="__search"
|
|
aria-label="Search"
|
|
>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
stroke-width="2"
|
|
class="lucide lucide-search"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<path d="m21 21-4.34-4.34" />
|
|
<circle cx="11" cy="11" r="8" />
|
|
</svg>
|
|
</label>
|
|
<div
|
|
class="md-search"
|
|
data-md-component="search"
|
|
role="dialog"
|
|
aria-label="Search"
|
|
>
|
|
<button type="button" class="md-search__button">Search</button>
|
|
</div>
|
|
|
|
<div class="md-header__source"></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="sidebar"
|
|
data-md-type="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="up"
|
|
class="md-nav__button md-logo"
|
|
aria-label="up"
|
|
data-md-component="logo"
|
|
>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
stroke-width="2"
|
|
class="lucide lucide-book-open"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<path
|
|
d="M12 7v14M3 18a1 1 0 0 1-1-1V4a1 1 0 0 1 1-1h5a4 4 0 0 1 4 4 4 4 0 0 1 4-4h5a1 1 0 0 1 1 1v13a1 1 0 0 1-1 1h-6a3 3 0 0 0-3 3 3 3 0 0 0-3-3z"
|
|
/>
|
|
</svg>
|
|
</a>
|
|
up
|
|
</label>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
<li class="md-nav__item md-nav__item--active">
|
|
<label
|
|
class="md-nav__link md-nav__link--active"
|
|
for="__toc"
|
|
>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
stroke-width="2"
|
|
class="lucide lucide-rocket"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<path
|
|
d="M12 15v5s3.03-.55 4-2c1.08-1.62 0-5 0-5M4.5 16.5c-1.5 1.26-2 5-2 5s3.74-.5 5-2c.71-.84.7-2.13-.09-2.91a2.18 2.18 0 0 0-2.91-.09"
|
|
/>
|
|
<path
|
|
d="M9 12a22 22 0 0 1 2-3.95A12.88 12.88 0 0 1 22 2c0 2.72-.78 7.5-6 11a22.4 22.4 0 0 1-4 2z"
|
|
/>
|
|
<path
|
|
d="M9 12H4s.55-3.03 2-4c1.62-1.08 5 .05 5 .05"
|
|
/>
|
|
</svg>
|
|
|
|
<span class="md-ellipsis"> Welcome! </span>
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="" class="md-nav__link md-nav__link--active">
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
stroke-width="2"
|
|
class="lucide lucide-rocket"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<path
|
|
d="M12 15v5s3.03-.55 4-2c1.08-1.62 0-5 0-5M4.5 16.5c-1.5 1.26-2 5-2 5s3.74-.5 5-2c.71-.84.7-2.13-.09-2.91a2.18 2.18 0 0 0-2.91-.09"
|
|
/>
|
|
<path
|
|
d="M9 12a22 22 0 0 1 2-3.95A12.88 12.88 0 0 1 22 2c0 2.72-.78 7.5-6 11a22.4 22.4 0 0 1-4 2z"
|
|
/>
|
|
<path
|
|
d="M9 12H4s.55-3.03 2-4c1.62-1.08 5 .05 5 .05"
|
|
/>
|
|
</svg>
|
|
|
|
<span class="md-ellipsis"> Welcome! </span>
|
|
</a>
|
|
|
|
<nav
|
|
class="md-nav md-nav--secondary"
|
|
aria-label="On this page"
|
|
>
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
On this page
|
|
</label>
|
|
<ul
|
|
class="md-nav__list"
|
|
data-md-component="toc"
|
|
data-md-scrollfix
|
|
>
|
|
<li class="md-nav__item">
|
|
<a href="#commands" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Commands </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#markdown" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> [[markdown]] </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Examples </span>
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Examples">
|
|
<ul class="md-nav__list">
|
|
<li class="md-nav__item">
|
|
<a href="#admonitions" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset">
|
|
Admonitions
|
|
</span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#details" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Details </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#code-blocks" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Code Blocks </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#content-tabs" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Content tabs </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#diagrams" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Diagrams </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#footnotes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Footnotes </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#formatting" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Formatting </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#icons-emojis" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Icons, Emojis </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#maths" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Maths </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#task-lists" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Task Lists </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tooltips" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Tooltips </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#footnotes_1" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Footnotes </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="./markdown/" class="md-nav__link">
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<path
|
|
d="M22.27 19.385H1.73A1.73 1.73 0 0 1 0 17.655V6.345a1.73 1.73 0 0 1 1.73-1.73h20.54A1.73 1.73 0 0 1 24 6.345v11.308a1.73 1.73 0 0 1-1.73 1.731zM5.769 15.923v-4.5l2.308 2.885 2.307-2.885v4.5h2.308V8.078h-2.308l-2.307 2.885-2.308-2.885H3.46v7.847zM21.232 12h-2.309V8.077h-2.307V12h-2.308l3.461 4.039z"
|
|
/>
|
|
</svg>
|
|
|
|
<span class="md-ellipsis"> Markdown in 5min </span>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div
|
|
class="md-sidebar md-sidebar--secondary"
|
|
data-md-component="sidebar"
|
|
data-md-type="toc"
|
|
>
|
|
<div class="md-sidebar__scrollwrap">
|
|
<input
|
|
class="md-nav__toggle md-toggle"
|
|
type="checkbox"
|
|
id="__toc"
|
|
/>
|
|
<div class="md-sidebar-button__wrapper">
|
|
<label class="md-sidebar-button" for="__toc"></label>
|
|
</div>
|
|
|
|
<div class="md-sidebar__inner">
|
|
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
On this page
|
|
</label>
|
|
<ul
|
|
class="md-nav__list"
|
|
data-md-component="toc"
|
|
data-md-scrollfix
|
|
>
|
|
<li class="md-nav__item">
|
|
<a href="#commands" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Commands </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#markdown" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> [[markdown]] </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#examples" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Examples </span>
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Examples">
|
|
<ul class="md-nav__list">
|
|
<li class="md-nav__item">
|
|
<a href="#admonitions" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Admonitions </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#details" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Details </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#code-blocks" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Code Blocks </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#content-tabs" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Content tabs </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#diagrams" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Diagrams </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#footnotes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Footnotes </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#formatting" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Formatting </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#icons-emojis" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Icons, Emojis </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#maths" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Maths </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#task-lists" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Task Lists </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tooltips" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Tooltips </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#footnotes_1" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
<span class="md-typeset"> Footnotes </span>
|
|
</span>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
<h1 id="welcome">
|
|
Welcome!<a
|
|
class="headerlink"
|
|
href="#welcome"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h1>
|
|
<p>
|
|
For full documentation visit
|
|
<a href="https://zensical.org/docs/">zensical.org</a>.
|
|
</p>
|
|
<h2 id="commands">
|
|
Commands<a
|
|
class="headerlink"
|
|
href="#commands"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<ul>
|
|
<li><code>zensical new</code> - Create a new project</li>
|
|
<li><code>zensical serve</code> - Start local web server</li>
|
|
<li><code>zensical build</code> - Build your site</li>
|
|
</ul>
|
|
<h2 id="markdown">
|
|
[[markdown]]<a
|
|
class="headerlink"
|
|
href="#markdown"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<h2 id="examples">
|
|
Examples<a
|
|
class="headerlink"
|
|
href="#examples"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<h3 id="admonitions">
|
|
Admonitions<a
|
|
class="headerlink"
|
|
href="#admonitions"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h3>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a href="https://zensical.org/docs/authoring/admonitions/"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
</div>
|
|
<div class="language-text highlight">
|
|
<pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>This is a **note** admonition. Use it to provide helpful information.
|
|
</span></code></pre>
|
|
</div>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Warning</p>
|
|
</div>
|
|
<div class="language-text highlight">
|
|
<pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>This is a **warning** admonition. Be careful!
|
|
</span></code></pre>
|
|
</div>
|
|
<h3 id="details">
|
|
Details<a
|
|
class="headerlink"
|
|
href="#details"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h3>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a
|
|
href="https://zensical.org/docs/authoring/admonitions/#collapsible-blocks"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<details class="info">
|
|
<summary>Click to expand for more info</summary>
|
|
</details>
|
|
<div class="language-text highlight">
|
|
<pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>This content is hidden until you click to expand it.
|
|
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>Great for FAQs or long explanations.
|
|
</span></code></pre>
|
|
</div>
|
|
<h2 id="code-blocks">
|
|
Code Blocks<a
|
|
class="headerlink"
|
|
href="#code-blocks"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a href="https://zensical.org/docs/authoring/code-blocks/"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<div class="language-python highlight">
|
|
<pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">greet</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
|
|
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Hello, </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">!"</span><span class="p">)</span> <span class="c1"># (1)!</span>
|
|
</span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>
|
|
</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="n">greet</span><span class="p">(</span><span class="s2">"Python"</span><span class="p">)</span>
|
|
</span></code></pre>
|
|
</div>
|
|
<ol>
|
|
<li>
|
|
Go to
|
|
<a
|
|
href="https://zensical.org/docs/authoring/code-blocks/#code-annotations"
|
|
>documentation</a
|
|
>
|
|
</li>
|
|
</ol>
|
|
<p>Code annotations allow to attach notes to lines of code.</p>
|
|
<p>
|
|
Code can also be highlighted inline:
|
|
<code class="language-python highlight"
|
|
><span class="nb">print</span><span class="p">(</span
|
|
><span class="s2">"Hello, Python!"</span
|
|
><span class="p">)</span></code
|
|
>.
|
|
</p>
|
|
<h2 id="content-tabs">
|
|
Content tabs<a
|
|
class="headerlink"
|
|
href="#content-tabs"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a href="https://zensical.org/docs/authoring/content-tabs/"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="1:1">
|
|
<input
|
|
checked="checked"
|
|
id="__tabbed_1_1"
|
|
name="__tabbed_1"
|
|
type="radio"
|
|
/>
|
|
<div class="tabbed-labels">
|
|
<label for="__tabbed_1_1">Python</label>
|
|
</div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block"></div>
|
|
</div>
|
|
</div>
|
|
<div class="language-text highlight">
|
|
<pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>``` python
|
|
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>print("Hello from Python!")
|
|
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>```
|
|
</span></code></pre>
|
|
</div>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="2:1">
|
|
<input
|
|
checked="checked"
|
|
id="__tabbed_2_1"
|
|
name="__tabbed_2"
|
|
type="radio"
|
|
/>
|
|
<div class="tabbed-labels">
|
|
<label for="__tabbed_2_1">Rust</label>
|
|
</div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block"></div>
|
|
</div>
|
|
</div>
|
|
<div class="language-text highlight">
|
|
<pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>``` rs
|
|
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>println!("Hello from Rust!");
|
|
</span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>```
|
|
</span></code></pre>
|
|
</div>
|
|
<h2 id="diagrams">
|
|
Diagrams<a
|
|
class="headerlink"
|
|
href="#diagrams"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a href="https://zensical.org/docs/authoring/diagrams/"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<pre class="mermaid"><code>graph LR
|
|
A[Start] --> B{Error?};
|
|
B -->|Yes| C[Hmm...];
|
|
C --> D[Debug];
|
|
D --> B;
|
|
B ---->|No| E[Yay!];</code></pre>
|
|
<h2 id="footnotes">
|
|
Footnotes<a
|
|
class="headerlink"
|
|
href="#footnotes"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a href="https://zensical.org/docs/authoring/footnotes/"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<p>
|
|
Here's a sentence with a footnote.<a href="#user-content-fn-1"
|
|
>1</a
|
|
>
|
|
</p>
|
|
<p>Hover it, to see a tooltip.</p>
|
|
<h2 id="formatting">
|
|
Formatting<a
|
|
class="headerlink"
|
|
href="#formatting"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a href="https://zensical.org/docs/authoring/formatting/"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<ul>
|
|
<li><mark>This was marked (highlight)</mark></li>
|
|
<li><ins>This was inserted (underline)</ins></li>
|
|
<li><del>This was deleted (strikethrough)</del></li>
|
|
<li>H<sub>~2</sub>~O</li>
|
|
<li>A<sup>T</sup>A</li>
|
|
<li>
|
|
<span class="keys"
|
|
><kbd class="key-control">Ctrl</kbd><span>+</span
|
|
><kbd class="key-alt">Alt</kbd><span>+</span
|
|
><kbd class="key-delete">Del</kbd></span
|
|
>
|
|
</li>
|
|
</ul>
|
|
<h2 id="icons-emojis">
|
|
Icons, Emojis<a
|
|
class="headerlink"
|
|
href="#icons-emojis"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a href="https://zensical.org/docs/authoring/icons-emojis/"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<ul>
|
|
<li>
|
|
<img
|
|
alt="✨"
|
|
class="twemoji"
|
|
src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@16.0.1/assets/svg/2728.svg"
|
|
title=":sparkles:"
|
|
/>
|
|
<code>:sparkles:</code>
|
|
</li>
|
|
<li>
|
|
<img
|
|
alt="🚀"
|
|
class="twemoji"
|
|
src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@16.0.1/assets/svg/1f680.svg"
|
|
title=":rocket:"
|
|
/>
|
|
<code>:rocket:</code>
|
|
</li>
|
|
<li>
|
|
<img
|
|
alt="🎉"
|
|
class="twemoji"
|
|
src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@16.0.1/assets/svg/1f389.svg"
|
|
title=":tada:"
|
|
/>
|
|
<code>:tada:</code>
|
|
</li>
|
|
<li>
|
|
<img
|
|
alt="📝"
|
|
class="twemoji"
|
|
src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@16.0.1/assets/svg/1f4dd.svg"
|
|
title=":memo:"
|
|
/>
|
|
<code>:memo:</code>
|
|
</li>
|
|
<li>
|
|
<img
|
|
alt="👀"
|
|
class="twemoji"
|
|
src="https://cdn.jsdelivr.net/gh/jdecked/twemoji@16.0.1/assets/svg/1f440.svg"
|
|
title=":eyes:"
|
|
/>
|
|
<code>:eyes:</code>
|
|
</li>
|
|
</ul>
|
|
<h2 id="maths">
|
|
Maths<a class="headerlink" href="#maths" title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a href="https://zensical.org/docs/authoring/math/"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<div class="arithmatex">
|
|
\[ \cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k} \]
|
|
</div>
|
|
<p>
|
|
!!! warning "Needs configuration"\ Note that MathJax is included
|
|
via a <code>script</code> tag on this page and is not\
|
|
configured in the generated default configuration to avoid
|
|
including it\ in a pages that do not need it. See the
|
|
documentation for details on how\ to configure it on all your
|
|
pages if they are more Maths-heavy than these\ simple starter
|
|
pages.
|
|
</p>
|
|
<h2 id="task-lists">
|
|
Task Lists<a
|
|
class="headerlink"
|
|
href="#task-lists"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a
|
|
href="https://zensical.org/docs/authoring/lists/#using-task-lists"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<ul class="task-list">
|
|
<li class="task-list-item">
|
|
<label class="task-list-control"
|
|
><input type="checkbox" disabled checked /><span
|
|
class="task-list-indicator"
|
|
></span
|
|
></label>
|
|
Install Zensical
|
|
</li>
|
|
<li class="task-list-item">
|
|
<label class="task-list-control"
|
|
><input type="checkbox" disabled checked /><span
|
|
class="task-list-indicator"
|
|
></span
|
|
></label>
|
|
Configure <code>zensical.toml</code>
|
|
</li>
|
|
<li class="task-list-item">
|
|
<label class="task-list-control"
|
|
><input type="checkbox" disabled checked /><span
|
|
class="task-list-indicator"
|
|
></span
|
|
></label>
|
|
Write amazing documentation
|
|
</li>
|
|
<li class="task-list-item">
|
|
<label class="task-list-control"
|
|
><input type="checkbox" disabled /><span
|
|
class="task-list-indicator"
|
|
></span
|
|
></label>
|
|
Deploy anywhere
|
|
</li>
|
|
</ul>
|
|
<h2 id="tooltips">
|
|
Tooltips<a
|
|
class="headerlink"
|
|
href="#tooltips"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<blockquote>
|
|
<p>
|
|
Go to
|
|
<a href="https://zensical.org/docs/authoring/tooltips/"
|
|
>documentation</a
|
|
>
|
|
</p>
|
|
</blockquote>
|
|
<p><a href="https://example.com">Hover me</a></p>
|
|
<h2 id="footnotes_1">
|
|
Footnotes<a
|
|
class="headerlink"
|
|
href="#footnotes_1"
|
|
title="Permanent link"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<ol>
|
|
<li>
|
|
This is the footnote. <a href="#user-content-fnref-1">↩</a>
|
|
</li>
|
|
</ol>
|
|
</article>
|
|
</div>
|
|
|
|
<script>
|
|
var tabs = __md_get("__tabs");
|
|
if (Array.isArray(tabs))
|
|
e: for (var set of document.querySelectorAll(".tabbed-set")) {
|
|
var labels = set.querySelector(".tabbed-labels");
|
|
for (var tab of tabs)
|
|
for (var label of labels.getElementsByTagName("label"))
|
|
if (label.innerText.trim() === tab) {
|
|
var input = document.getElementById(label.htmlFor);
|
|
input.checked = !0;
|
|
continue e;
|
|
}
|
|
}
|
|
</script>
|
|
|
|
<script>
|
|
var target = document.getElementById(location.hash.slice(1));
|
|
target &&
|
|
target.name &&
|
|
(target.checked = target.name.startsWith("__tabbed_"));
|
|
</script>
|
|
</div>
|
|
|
|
<button
|
|
type="button"
|
|
class="md-top md-icon"
|
|
data-md-component="top"
|
|
hidden
|
|
>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
stroke-width="2"
|
|
class="lucide lucide-circle-arrow-up"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<circle cx="12" cy="12" r="10" />
|
|
<path d="m16 12-4-4-4 4M12 16V8" />
|
|
</svg>
|
|
Back to top
|
|
</button>
|
|
</main>
|
|
|
|
<footer class="md-footer">
|
|
<nav class="md-footer__inner md-grid" aria-label="Footer">
|
|
<a
|
|
href="./markdown/"
|
|
class="md-footer__link md-footer__link--next"
|
|
aria-label="Next: Markdown in 5min"
|
|
>
|
|
<div class="md-footer__title">
|
|
<span class="md-footer__direction"> Next </span>
|
|
<div class="md-ellipsis">Markdown in 5min</div>
|
|
</div>
|
|
<div class="md-footer__button md-icon">
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
stroke-width="2"
|
|
class="lucide lucide-arrow-right"
|
|
viewBox="0 0 24 24"
|
|
>
|
|
<path d="M5 12h14M12 5l7 7-7 7" />
|
|
</svg>
|
|
</div>
|
|
</a>
|
|
</nav>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-copyright">
|
|
<div class="md-copyright__highlight">
|
|
Copyright © 2026 The authors
|
|
</div>
|
|
|
|
Made with
|
|
<a href="https://zensical.org/" target="_blank" rel="noopener">
|
|
Zensical
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
|
|
<script id="__config" type="application/json">
|
|
{
|
|
"annotate": null,
|
|
"base": ".",
|
|
"features": [
|
|
"announce.dismiss",
|
|
"content.code.annotate",
|
|
"content.code.copy",
|
|
"content.code.select",
|
|
"content.footnote.tooltips",
|
|
"content.tabs.link",
|
|
"content.tooltips",
|
|
"navigation.footer",
|
|
"navigation.indexes",
|
|
"navigation.instant",
|
|
"navigation.instant.prefetch",
|
|
"navigation.path",
|
|
"navigation.sections",
|
|
"navigation.top",
|
|
"navigation.tracking",
|
|
"search.highlight"
|
|
],
|
|
"search": "./assets/javascripts/workers/search.e2d2d235.min.js",
|
|
"tags": null,
|
|
"translations": {
|
|
"clipboard.copied": "Copied to clipboard",
|
|
"clipboard.copy": "Copy to clipboard",
|
|
"search.result.more.one": "1 more on this page",
|
|
"search.result.more.other": "# more on this page",
|
|
"search.result.none": "No matching documents",
|
|
"search.result.one": "1 matching document",
|
|
"search.result.other": "# matching documents",
|
|
"search.result.placeholder": "Type to start searching",
|
|
"search.result.term.missing": "Missing",
|
|
"select.version": "Select version"
|
|
},
|
|
"version": null
|
|
}
|
|
</script>
|
|
|
|
<script src="./assets/javascripts/bundle.6e5f0216.min.js"></script>
|
|
</body>
|
|
</html>
|