mirror of
https://github.com/logos-co/roadmap.git
synced 2025-01-27 16:34:51 +00:00
100 lines
16 KiB
HTML
100 lines
16 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html><head><title>Authoring Content</title><meta charSet="utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta property="og:title" content="Authoring Content"/><meta property="og:description" content="All of the content in your Quartz should go in the /content folder. The content for the home page of your Quartz lives in content/index.md. If you’ve setup Quartz already, this folder should already be initailized."/><meta property="og:image" content="https://roadmap.logos.co/static/og-image.png"/><meta property="og:width" content="1200"/><meta property="og:height" content="675"/><link rel="icon" href="./static/icon.png"/><meta name="description" content="All of the content in your Quartz should go in the /content folder. The content for the home page of your Quartz lives in content/index.md. If you’ve setup Quartz already, this folder should already be initailized."/><meta name="generator" content="Quartz"/><link rel="preconnect" href="https://fonts.googleapis.com"/><link rel="preconnect" href="https://fonts.gstatic.com"/><link href="./index.css" rel="stylesheet" type="text/css" spa-preserve/><link href="https://cdn.jsdelivr.net/npm/katex@0.16.0/dist/katex.min.css" rel="stylesheet" type="text/css" spa-preserve/><link href="https://fonts.googleapis.com/css2?family=IBM Plex Mono&family=Schibsted Grotesk:wght@400;700&family=Source Sans Pro:ital,wght@0,400;0,600;1,400;1,600&display=swap" rel="stylesheet" type="text/css" spa-preserve/><script src="./prescript.js" type="application/javascript" spa-preserve></script><script type="application/javascript" spa-preserve>const fetchData = fetch(`./static/contentIndex.json`).then(data => data.json())</script></head><body data-slug="authoring-content"><div id="quartz-root" class="page"><div id="quartz-body"><div class="left sidebar"><h1 class="page-title"><a href=".">Logos Collective Project Roadmaps</a></h1><div class="spacer mobile-only"></div><div class="search"><div id="search-icon"><p>Search</p><div></div><svg tabIndex="0" aria-labelledby="title desc" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 19.9 19.7"><title id="title">Search</title><desc id="desc">Search</desc><g class="search-path" fill="none"><path stroke-linecap="square" d="M18.5 18.3l-5.4-5.4"></path><circle cx="8" cy="8" r="7"></circle></g></svg></div><div id="search-container"><div id="search-space"><input autocomplete="off" id="search-bar" name="search" type="text" aria-label="Search for something" placeholder="Search for something"/><div id="results-container"></div></div></div></div><div class="darkmode"><input class="toggle" id="darkmode-toggle" type="checkbox" tabIndex="-1"/><label id="toggle-label-light" for="darkmode-toggle" tabIndex="-1"><svg xmlns="http://www.w3.org/2000/svg" xmlnsXlink="http://www.w3.org/1999/xlink" version="1.1" id="dayIcon" x="0px" y="0px" viewBox="0 0 35 35" style="enable-background:new 0 0 35 35;" xmlSpace="preserve"><title>Light mode</title><path d="M6,17.5C6,16.672,5.328,16,4.5,16h-3C0.672,16,0,16.672,0,17.5 S0.672,19,1.5,19h3C5.328,19,6,18.328,6,17.5z M7.5,26c-0.414,0-0.789,0.168-1.061,0.439l-2,2C4.168,28.711,4,29.086,4,29.5 C4,30.328,4.671,31,5.5,31c0.414,0,0.789-0.168,1.06-0.44l2-2C8.832,28.289,9,27.914,9,27.5C9,26.672,8.329,26,7.5,26z M17.5,6 C18.329,6,19,5.328,19,4.5v-3C19,0.672,18.329,0,17.5,0S16,0.672,16,1.5v3C16,5.328,16.671,6,17.5,6z M27.5,9 c0.414,0,0.789-0.168,1.06-0.439l2-2C30.832,6.289,31,5.914,31,5.5C31,4.672,30.329,4,29.5,4c-0.414,0-0.789,0.168-1.061,0.44 l-2,2C26.168,6.711,26,7.086,26,7.5C26,8.328,26.671,9,27.5,9z M6.439,8.561C6.711,8.832,7.086,9,7.5,9C8.328,9,9,8.328,9,7.5 c0-0.414-0.168-0.789-0.439-1.061l-2-2C6.289,4.168,5.914,4,5.5,4C4.672,4,4,4.672,4,5.5c0,0.414,0.168,0.789,0.439,1.06 L6.439,8.561z M33.5,16h-3c-0.828,0-1.5,0.672-1.5,1.5s0.672,1.5,1.5,1.5h3c0.828,0,1.5-0.672,1.5-1.5S34.328,16,33.5,16z M28.561,26.439C28.289,26.168,27.914,26,27.5,26c-0.828,0-1.5,0.672-1.5,1.5c0,0.414,0.168,0.789,0.439,1.06l2,2 C28.711,30.832,29.086,31,29.5,31c0.828,0,1.5-0.672,1.5-1.5c0-0.414-0.16
|
|||
|
|
<p>It is recommended that you use <a href="https://obsidian.md/" class="external">Obsidian</a> as a way to edit and maintain your Quartz. It comes with a nice editor and graphical interface to preview, edit, and link your local files and attachments.</p>
|
|||
|
|
<p>Got everything setup? Let’s <a href="./build" class="internal">build</a> and preview your Quartz locally!</p>
|
|||
|
|
<h2 id="syntax">Syntax<a aria-hidden="true" tabindex="-1" href="#syntax" class="internal"> §</a></h2>
|
|||
|
|
<p>As Quartz uses Markdown files as the main way of writing content, it fully supports Markdown syntax. By default, Quartz also ships with a few syntax extensions like <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax" class="external">Github Flavored Markdown</a> (footnotes, strikethrough, tables, tasklists) and <a href="https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown" class="external">Obsidian Flavored Markdown</a> (<a href="./callouts" class="internal">callouts</a>, <a href="./wikilinks" class="internal">wikilinks</a>).</p>
|
|||
|
|
<p>Additionally, Quartz also allows you to specify additional metadata in your notes called <strong>frontmatter</strong>.</p>
|
|||
|
|
<div data-rehype-pretty-code-fragment><div data-rehype-pretty-code-title data-language="md" data-theme="default">content/note.md</div><pre style="background-color:var(--shiki-color-background);" tabindex="0" data-language="md" data-theme="default"><code data-language="md" data-theme="default"><span data-line><span style="color:var(--shiki-color-text);">---</span></span>
|
|||
|
|
<span data-line><span style="color:var(--shiki-token-keyword);">title</span><span style="color:var(--shiki-token-keyword);">:</span><span style="color:var(--shiki-color-text);"> </span><span style="color:var(--shiki-token-string-expression);">Example Title</span></span>
|
|||
|
|
<span data-line><span style="color:var(--shiki-token-keyword);">draft</span><span style="color:var(--shiki-token-keyword);">:</span><span style="color:var(--shiki-color-text);"> </span><span style="color:var(--shiki-token-constant);">false</span></span>
|
|||
|
|
<span data-line><span style="color:var(--shiki-token-keyword);">tags</span><span style="color:var(--shiki-token-keyword);">:</span></span>
|
|||
|
|
<span data-line><span style="color:var(--shiki-color-text);"> - </span><span style="color:var(--shiki-token-string-expression);">example-tag</span></span>
|
|||
|
|
<span data-line><span style="color:var(--shiki-color-text);">---</span></span>
|
|||
|
|
<span data-line> </span>
|
|||
|
|
<span data-line><span style="color:var(--shiki-color-text);">The rest of your content lives here. You can use </span><span style="color:var(--shiki-color-text);font-weight:bold;">**Markdown**</span><span style="color:var(--shiki-color-text);"> here :)</span></span></code></pre></div>
|
|||
|
|
<p>Some common frontmatter fields that are natively supported by Quartz:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>title</code>: Title of the page. If it isn’t provided, Quartz will use the name of the file as the title.</li>
|
|||
|
|
<li><code>aliases</code>: Other names for this note. This is a list of strings.</li>
|
|||
|
|
<li><code>draft</code>: Whether to publish the page or not. This is one way to make <a href="./private-pages" class="internal">pages private</a> in Quartz.</li>
|
|||
|
|
<li><code>date</code>: A string representing the day the note was published. Normally uses <code>YYYY-MM-DD</code> format.</li>
|
|||
|
|
</ul>
|
|||
|
|
<h2 id="syncing-your-content">Syncing your Content<a aria-hidden="true" tabindex="-1" href="#syncing-your-content" class="internal"> §</a></h2>
|
|||
|
|
<p>When you’re Quartz is at a point you’re happy with, you can save your changes to GitHub by doing <code>npx quartz sync</code>.</p>
|
|||
|
|
<blockquote class="callout" data-callout="tip">
|
|||
|
|
<div class="callout-title">
|
|||
|
|
<div class="callout-icon"><svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M8.5 14.5A2.5 2.5 0 0 0 11 12c0-1.38-.5-2-1-3-1.072-2.143-.224-4.054 2-6 .5 2.5 2 4.9 4 6.5 2 1.6 3 3.5 3 5.5a7 7 0 1 1-14 0c0-1.153.433-2.294 1-3a2.5 2.5 0 0 0 2.5 2.5z"></path></svg></div>
|
|||
|
|
<div class="callout-title-inner"><p>Flags and options </p></div>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<p>For full help options, you can run <code>npx quartz sync --help</code>.</p>
|
|||
|
|
<p>Most of these have sensible defaults but you can override them if you have a custom setup:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li><code>-d</code> or <code>--directory</code>: the content folder. This is normally just <code>content</code></li>
|
|||
|
|
<li><code>-v</code> or <code>--verbose</code>: print out extra logging information</li>
|
|||
|
|
<li><code>--commit</code> or <code>--no-commit</code>: whether to make a <code>git</code> commit for your changes</li>
|
|||
|
|
<li><code>--push</code> or <code>--no-push</code>: whether to push updates to your GitHub fork of Quartz</li>
|
|||
|
|
<li><code>--pull</code> or <code>--no-pull</code>: whether to try and pull in any updates from your GitHub fork (i.e. from other devices) before pushing</li>
|
|||
|
|
</ul>
|
|||
|
|
</blockquote></article></div><div class="right sidebar"><div class="graph"><h3>Graph View</h3><div class="graph-outer"><div id="graph-container" data-cfg="{"drag":true,"zoom":true,"depth":1,"scale":1.1,"repelForce":0.5,"centerForce":0.3,"linkDistance":30,"fontSize":0.6,"opacityScale":1}"></div><svg version="1.1" id="global-graph-icon" xmlns="http://www.w3.org/2000/svg" xmlnsXlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 55 55" fill="currentColor" xmlSpace="preserve"><path d="M49,0c-3.309,0-6,2.691-6,6c0,1.035,0.263,2.009,0.726,2.86l-9.829,9.829C32.542,17.634,30.846,17,29,17
|
|||
|
|
s-3.542,0.634-4.898,1.688l-7.669-7.669C16.785,10.424,17,9.74,17,9c0-2.206-1.794-4-4-4S9,6.794,9,9s1.794,4,4,4
|
|||
|
|
c0.74,0,1.424-0.215,2.019-0.567l7.669,7.669C21.634,21.458,21,23.154,21,25s0.634,3.542,1.688,4.897L10.024,42.562
|
|||
|
|
C8.958,41.595,7.549,41,6,41c-3.309,0-6,2.691-6,6s2.691,6,6,6s6-2.691,6-6c0-1.035-0.263-2.009-0.726-2.86l12.829-12.829
|
|||
|
|
c1.106,0.86,2.44,1.436,3.898,1.619v10.16c-2.833,0.478-5,2.942-5,5.91c0,3.309,2.691,6,6,6s6-2.691,6-6c0-2.967-2.167-5.431-5-5.91
|
|||
|
|
v-10.16c1.458-0.183,2.792-0.759,3.898-1.619l7.669,7.669C41.215,39.576,41,40.26,41,41c0,2.206,1.794,4,4,4s4-1.794,4-4
|
|||
|
|
s-1.794-4-4-4c-0.74,0-1.424,0.215-2.019,0.567l-7.669-7.669C36.366,28.542,37,26.846,37,25s-0.634-3.542-1.688-4.897l9.665-9.665
|
|||
|
|
C46.042,11.405,47.451,12,49,12c3.309,0,6-2.691,6-6S52.309,0,49,0z M11,9c0-1.103,0.897-2,2-2s2,0.897,2,2s-0.897,2-2,2
|
|||
|
|
S11,10.103,11,9z M6,51c-2.206,0-4-1.794-4-4s1.794-4,4-4s4,1.794,4,4S8.206,51,6,51z M33,49c0,2.206-1.794,4-4,4s-4-1.794-4-4
|
|||
|
|
s1.794-4,4-4S33,46.794,33,49z M29,31c-3.309,0-6-2.691-6-6s2.691-6,6-6s6,2.691,6,6S32.309,31,29,31z M47,41c0,1.103-0.897,2-2,2
|
|||
|
|
s-2-0.897-2-2s0.897-2,2-2S47,39.897,47,41z M49,10c-2.206,0-4-1.794-4-4s1.794-4,4-4s4,1.794,4,4S51.206,10,49,10z"></path></svg></div><div id="global-graph-outer"><div id="global-graph-container" data-cfg="{"drag":true,"zoom":true,"depth":-1,"scale":0.9,"repelForce":0.5,"centerForce":0.3,"linkDistance":30,"fontSize":0.6,"opacityScale":1}"></div></div></div><div class="backlinks"><h3>Backlinks</h3><ul class="overflow"><li><a href="./index_default" class="internal">Welcome to Quartz 4</a></li></ul></div></div></div><footer><hr/><p>Created by Logos with <a href="https://quartz.jzhao.xyz/">Quartz v4.0.8</a>, © 2023</p><ul><li><a href="https://github.com/logos-co/roadmap">GitHub</a></li><li><a href="https://discord.com/invite/logos-state">Discord Community</a></li></ul></footer></div></body><script type="application/javascript">// quartz/components/scripts/quartz/components/scripts/callout.inline.ts
|
|||
|
|
function toggleCallout() {
|
|||
|
|
const outerBlock = this.parentElement;
|
|||
|
|
outerBlock.classList.toggle(`is-collapsed`);
|
|||
|
|
const collapsed = outerBlock.classList.contains(`is-collapsed`);
|
|||
|
|
const height = collapsed ? this.scrollHeight : outerBlock.scrollHeight;
|
|||
|
|
outerBlock.style.maxHeight = height + `px`;
|
|||
|
|
let current = outerBlock;
|
|||
|
|
let parent = outerBlock.parentElement;
|
|||
|
|
while (parent) {
|
|||
|
|
if (!parent.classList.contains(`callout`)) {
|
|||
|
|
return;
|
|||
|
|
}
|
|||
|
|
const collapsed2 = parent.classList.contains(`is-collapsed`);
|
|||
|
|
const height2 = collapsed2 ? parent.scrollHeight : parent.scrollHeight + current.scrollHeight;
|
|||
|
|
parent.style.maxHeight = height2 + `px`;
|
|||
|
|
current = parent;
|
|||
|
|
parent = parent.parentElement;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
function setupCallout() {
|
|||
|
|
const collapsible = document.getElementsByClassName(
|
|||
|
|
`callout is-collapsible`
|
|||
|
|
);
|
|||
|
|
for (const div of collapsible) {
|
|||
|
|
const title = div.firstElementChild;
|
|||
|
|
if (title) {
|
|||
|
|
title.removeEventListener(`click`, toggleCallout);
|
|||
|
|
title.addEventListener(`click`, toggleCallout);
|
|||
|
|
const collapsed = div.classList.contains(`is-collapsed`);
|
|||
|
|
const height = collapsed ? title.scrollHeight : div.scrollHeight;
|
|||
|
|
div.style.maxHeight = height + `px`;
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
document.addEventListener(`nav`, setupCallout);
|
|||
|
|
window.addEventListener(`resize`, setupCallout);
|
|||
|
|
</script><script type="module">
|
|||
|
|
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.esm.min.mjs';
|
|||
|
|
const darkMode = document.documentElement.getAttribute('saved-theme') === 'dark'
|
|||
|
|
mermaid.initialize({
|
|||
|
|
startOnLoad: false,
|
|||
|
|
securityLevel: 'loose',
|
|||
|
|
theme: darkMode ? 'dark' : 'default'
|
|||
|
|
});
|
|||
|
|
document.addEventListener('nav', async () => {
|
|||
|
|
await mermaid.run({
|
|||
|
|
querySelector: '.mermaid'
|
|||
|
|
})
|
|||
|
|
});
|
|||
|
|
</script><script src="https://cdn.jsdelivr.net/npm/katex@0.16.7/dist/contrib/copy-tex.min.js" type="application/javascript"></script><script src="./postscript.js" type="module"></script></html>
|