From 5771c50af55238406f3c322631bdbbd99bdc4322 Mon Sep 17 00:00:00 2001 From: Jenkins Date: Tue, 22 Aug 2023 19:29:56 +0000 Subject: [PATCH] Update documentation --- authoring-content.html | 100 ---------- build.html | 81 -------- configuration.html | 2 +- hosting.html | 2 +- index.html | 47 ++--- index.xml | 174 ++++++++++-------- index_default.html | 2 +- layout.html | 2 +- migrating-from-Quartz-3.html | 2 +- philosophy.html | 2 +- roadmap/acid/index.html | 2 +- roadmap/acid/milestones-overview.html | 4 +- roadmap/acid/overview.html | 66 +++++++ roadmap/acid/updates/2023-08-02.html | 2 +- roadmap/acid/updates/2023-08-09.html | 2 +- roadmap/acid/updates/index.html | 2 +- roadmap/codex/index.html | 2 +- roadmap/codex/milestones-overview.html | 4 +- roadmap/codex/overview.html | 66 +++++++ roadmap/codex/updates/2023-07-21.html | 2 +- roadmap/codex/updates/2023-08-01.html | 2 +- roadmap/codex/updates/2023-08-11.html | 2 +- roadmap/codex/updates/index.html | 2 +- roadmap/innovation_lab/index.html | 2 +- .../innovation_lab/milestones-overview.html | 4 +- roadmap/innovation_lab/overview.html | 66 +++++++ .../innovation_lab/updates/2023-07-12.html | 2 +- .../innovation_lab/updates/2023-08-02.html | 2 +- .../innovation_lab/updates/2023-08-11.html | 2 +- roadmap/innovation_lab/updates/index.html | 2 +- roadmap/nomos/index.html | 2 +- roadmap/nomos/milestones-overview.html | 4 +- roadmap/nomos/overview.html | 66 +++++++ roadmap/nomos/updates/2023-07-24.html | 2 +- roadmap/nomos/updates/2023-07-31.html | 2 +- roadmap/nomos/updates/2023-08-07.html | 2 +- roadmap/nomos/updates/2023-08-14.html | 2 +- roadmap/nomos/updates/index.html | 2 +- roadmap/vac/index.html | 2 +- roadmap/vac/milestones-overview.html | 4 +- roadmap/vac/overview.html | 66 +++++++ roadmap/vac/updates/2023-07-10.html | 2 +- roadmap/vac/updates/2023-07-17.html | 2 +- roadmap/vac/updates/2023-07-24.html | 2 +- roadmap/vac/updates/2023-07-31.html | 2 +- roadmap/vac/updates/2023-08-07.html | 2 +- roadmap/vac/updates/2023-08-14.html | 2 +- roadmap/vac/updates/2023-08-21.html | 2 +- roadmap/vac/updates/index.html | 2 +- roadmap/waku/index.html | 2 +- roadmap/waku/milestone-waku-10-users.html | 2 +- roadmap/waku/milestones-overview.html | 4 +- roadmap/waku/overview.html | 66 +++++++ roadmap/waku/updates/2023-07-24.html | 2 +- roadmap/waku/updates/2023-07-31.html | 2 +- roadmap/waku/updates/2023-08-06.html | 2 +- roadmap/waku/updates/2023-08-14.html | 2 +- roadmap/waku/updates/2023-08-21.html | 2 +- roadmap/waku/updates/index.html | 2 +- showcase.html | 2 +- sitemap.xml | 84 +++++---- static/contentIndex.json | 2 +- tags/139.html | 2 +- tags/166.html | 2 +- tags/479.html | 2 +- tags/acid-updates.html | 2 +- tags/codex-updates.html | 2 +- tags/component.html | 2 +- tags/ilab-updates.html | 2 +- tags/index.html | 2 +- tags/milestones-overview.html | 2 +- tags/milestones.html | 2 +- tags/nomos-updates.html | 2 +- tags/overview.html | 52 ++++++ tags/team-updates.html | 2 +- tags/vac-updates.html | 2 +- tags/waku-roadmap.html | 52 ++++++ tags/waku-updates.html | 2 +- upgrading.html | 2 +- 79 files changed, 727 insertions(+), 403 deletions(-) delete mode 100644 authoring-content.html delete mode 100644 build.html create mode 100644 roadmap/acid/overview.html create mode 100644 roadmap/codex/overview.html create mode 100644 roadmap/innovation_lab/overview.html create mode 100644 roadmap/nomos/overview.html create mode 100644 roadmap/vac/overview.html create mode 100644 roadmap/waku/overview.html create mode 100644 tags/overview.html create mode 100644 tags/waku-roadmap.html diff --git a/authoring-content.html b/authoring-content.html deleted file mode 100644 index f103e4063..000000000 --- a/authoring-content.html +++ /dev/null @@ -1,100 +0,0 @@ - -Authoring 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. Any Markdown in this folder will get processed by Quartz.

-

It is recommended that you use Obsidian 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.

-

Got everything setup? Let’s build and preview your Quartz locally!

-

Syntax

-

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 Github Flavored Markdown (footnotes, strikethrough, tables, tasklists) and Obsidian Flavored Markdown (callouts, wikilinks).

-

Additionally, Quartz also allows you to specify additional metadata in your notes called frontmatter.

-
content/note.md
---
-title: Example Title
-draft: false
-tags:
-  - example-tag
----
- 
-The rest of your content lives here. You can use **Markdown** here :)
-

Some common frontmatter fields that are natively supported by Quartz:

-
    -
  • title: Title of the page. If it isn’t provided, Quartz will use the name of the file as the title.
  • -
  • aliases: Other names for this note. This is a list of strings.
  • -
  • draft: Whether to publish the page or not. This is one way to make pages private in Quartz.
  • -
  • date: A string representing the day the note was published. Normally uses YYYY-MM-DD format.
  • -
-

Syncing your Content

-

When you’re Quartz is at a point you’re happy with, you can save your changes to GitHub by doing npx quartz sync.

-
-
-
-

Flags and options

- -
-

For full help options, you can run npx quartz sync --help.

-

Most of these have sensible defaults but you can override them if you have a custom setup:

-
    -
  • -d or --directory: the content folder. This is normally just content
  • -
  • -v or --verbose: print out extra logging information
  • -
  • --commit or --no-commit: whether to make a git commit for your changes
  • -
  • --push or --no-push: whether to push updates to your GitHub fork of Quartz
  • -
  • --pull or --no-pull: whether to try and pull in any updates from your GitHub fork (i.e. from other devices) before pushing
  • -
-
\ No newline at end of file diff --git a/build.html b/build.html deleted file mode 100644 index 4f04f3118..000000000 --- a/build.html +++ /dev/null @@ -1,81 +0,0 @@ - -Building your Quartz

Once you’ve initialized Quartz, let’s see what it looks like locally:

-
npx quartz build --serve
-

This will start a local web server to run your Quartz on your computer. Open a web browser and visit http://localhost:8080/ to view it.

-
-
-
-

Flags and options

- -
-

For full help options, you can run npx quartz build --help.

-

Most of these have sensible defaults but you can override them if you have a custom setup:

-
    -
  • -d or --directory: the content folder. This is normally just content
  • -
  • -v or --verbose: print out extra logging information
  • -
  • -o or --output: the output folder. This is normally just public
  • -
  • --serve: run a local hot-reloading server to preview your Quartz
  • -
  • --port: what port to run the local preview server on
  • -
  • --concurrency: how many threads to use to parse notes
  • -
-
\ No newline at end of file diff --git a/configuration.html b/configuration.html index d21ee680f..e80890cfc 100644 --- a/configuration.html +++ b/configuration.html @@ -1,5 +1,5 @@ -Configuration

Quartz is meant to be extremely configurable, even if you don’t know any coding. Most of the configuration you should need can be done by just editing quartz.config.ts or changing the layout in quartz.layout.ts.

+Configuration

Quartz is meant to be extremely configurable, even if you don’t know any coding. Most of the configuration you should need can be done by just editing quartz.config.ts or changing the layout in quartz.layout.ts.

diff --git a/hosting.html b/hosting.html index 38dc12f46..63b53b475 100644 --- a/hosting.html +++ b/hosting.html @@ -1,5 +1,5 @@ -Hosting

Quartz effectively turns your Markdown files and other resources into a bundle of HTML, JS, and CSS files (a website!).

+Hosting

Quartz effectively turns your Markdown files and other resources into a bundle of HTML, JS, and CSS files (a website!).

However, if you’d like to publish your site to the world, you need a way to host it online. This guide will detail how to deploy with either GitHub Pages or Cloudflare pages but any service that allows you to deploy static HTML should work as well (e.g. Netlify, Replit, etc.)

diff --git a/index.html b/index.html index 4cc1e091e..36ea6c17f 100644 --- a/index.html +++ b/index.html @@ -1,35 +1,22 @@ -

This site attempts to inform the previous, current, and future work required to fulfill the requirements of the projects under the Logos Collective, a complete tech stack that provides infrastructure for the self-sovereign network state. To learn more about the motivation, please visit the Logos Collective Site.

+

This site attempts to inform the previous, current, and future work required to fulfill the requirements of the projects under the Logos Collective, a complete tech stack that provides infrastructure for the self-sovereign network state. To learn more about the motivation, please visit the Logos Collective Site.

+
+
+
+

Note

+ +
+

This site is an ongoing work in progress. The links within are an attempt to capture a lot of moving targets. This means that the information here may or may not be the bleeding edge of what is true with respect to the development within the Logos Collective projects.

+

It is our aim to continuously get closer to that target, but we will continuously fail at that. If you know something is out of date or incorrect, raise an issue or make a PR.

+
-

Waku

-

Codex

- -

Nomos

- -

Vac

- -

Innovation Lab

- -

Comms (Acid Info)

-

Quartz is a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites. Thousands of students, developers, and teachers are already using Quartz to publish personal notes, wikis, and digital gardens to the web.

+Welcome to Quartz 4

Quartz is a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites. Thousands of students, developers, and teachers are already using Quartz to publish personal notes, wikis, and digital gardens to the web.

🪴 Get Started

Quartz requires at least Node v18.14 to function correctly. Ensure you have this installed on your machine before continuing.

Then, in your terminal of choice, enter the following commands line by line:

diff --git a/layout.html b/layout.html index 089dcdca8..7151aaaff 100644 --- a/layout.html +++ b/layout.html @@ -1,5 +1,5 @@ -Layout

Certain emitters may also output HTML files. To enable easy customization, these emitters allow you to fully rearrange the layout of the page. The default page layouts can be found in quartz.layout.ts.

+Layout

Certain emitters may also output HTML files. To enable easy customization, these emitters allow you to fully rearrange the layout of the page. The default page layouts can be found in quartz.layout.ts.

Each page is composed of multiple different sections which contain QuartzComponents. The following code snippet lists all of the valid sections that you can add components to:

quartz/cfg.ts
export interface FullPageLayout {
   head: QuartzComponent // single component
diff --git a/migrating-from-Quartz-3.html b/migrating-from-Quartz-3.html
index db496e0a2..9394bebe0 100644
--- a/migrating-from-Quartz-3.html
+++ b/migrating-from-Quartz-3.html
@@ -1,5 +1,5 @@
 
-Migrating from Quartz 3

As you already have Quartz locally, you don’t need to fork or clone it again. Simply just checkout the alpha branch, install the dependencies, and import your old vault.

+Migrating from Quartz 3

As you already have Quartz locally, you don’t need to fork or clone it again. Simply just checkout the alpha branch, install the dependencies, and import your old vault.

git fetch
 git checkout v4
 git pull upstream v4
diff --git a/philosophy.html b/philosophy.html
index 65babee96..b6b53bda6 100644
--- a/philosophy.html
+++ b/philosophy.html
@@ -1,5 +1,5 @@
 
-Philosophy of Quartz

A garden should be a true hypertext

+Philosophy of Quartz

A garden should be a true hypertext

The garden is the web as topology. Every walk through the garden creates new paths, new meanings, and when we add things to the garden we add them in a way that allows many future, unpredicted relationships.

(The Garden and the Stream)

diff --git a/roadmap/acid/index.html b/roadmap/acid/index.html index 8b9a8892d..281750a5b 100644 --- a/roadmap/acid/index.html +++ b/roadmap/acid/index.html @@ -1,5 +1,5 @@ -Folder: roadmap/acid

1 items under this folder.

2 items under this folder.

    +Comms Milestones Overview
    • Comms Roadmap
    • Comms Projects
    • Comms planner deadlines
    • @@ -13,7 +13,7 @@ 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">
\ No newline at end of file diff --git a/roadmap/acid/updates/2023-08-02.html b/roadmap/acid/updates/2023-08-02.html index 9f61963f9..4a3a9f0e4 100644 --- a/roadmap/acid/updates/2023-08-02.html +++ b/roadmap/acid/updates/2023-08-02.html @@ -1,5 +1,5 @@ -2023-08-02 Acid weekly

Leads roundup - acid

+2023-08-02 Acid weekly

Leads roundup - acid

Al / Comms

  • Status app relaunch comms campaign plan in the works. Approx. date for launch 31.08.
  • diff --git a/roadmap/acid/updates/2023-08-09.html b/roadmap/acid/updates/2023-08-09.html index 9086490a4..705dc7371 100644 --- a/roadmap/acid/updates/2023-08-09.html +++ b/roadmap/acid/updates/2023-08-09.html @@ -1,5 +1,5 @@ -2023-08-09 Acid weekly

    Top level priorities:

    +2023-08-09 Acid weekly

    Top level priorities:

    Logos Growth Plan Status Relaunch Launch of LPE diff --git a/roadmap/acid/updates/index.html b/roadmap/acid/updates/index.html index 32e0345f8..51d1c3093 100644 --- a/roadmap/acid/updates/index.html +++ b/roadmap/acid/updates/index.html @@ -1,5 +1,5 @@ -Folder: roadmap/acid/updates

    2 items under this folder.

    2 items under this folder.

    1 items under this folder.

    Milestones

    +Codex Milestones Overview

    Milestones

    • Zenhub Tracker
    • Miro Tracker
    • @@ -13,7 +13,7 @@ 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">
    \ No newline at end of file diff --git a/roadmap/codex/updates/2023-07-21.html b/roadmap/codex/updates/2023-07-21.html index 691ee39fb..7eee9b441 100644 --- a/roadmap/codex/updates/2023-07-21.html +++ b/roadmap/codex/updates/2023-07-21.html @@ -1,5 +1,5 @@ -2023-07-21 Codex weekly

    Codex update 07/12/2023 to 07/21/2023

    +2023-07-21 Codex weekly

    Codex update 07/12/2023 to 07/21/2023

    Overall we continue working in various directions, distributed testing, marketplace, p2p client, research, etc…

    Our main milestone is to have a fully functional testnet with the marketplace and durability guarantees deployed by end of year. A lot of grunt work is being done to make that possible. Progress is steady, but there are lots of stabilization and testing & infra related work going on.

    We’re also onboarding several new members to the team (4 to be precise), this will ultimately accelerate our progress, but it requires some upfront investment from some of the more experienced team members.

    diff --git a/roadmap/codex/updates/2023-08-01.html b/roadmap/codex/updates/2023-08-01.html index 02a6fb2e1..9a6b9f320 100644 --- a/roadmap/codex/updates/2023-08-01.html +++ b/roadmap/codex/updates/2023-08-01.html @@ -1,5 +1,5 @@ -2023-08-01 Codex weekly

    Codex update Aug 1st

    +2023-08-01 Codex weekly

    Codex update Aug 1st

    Client

    Milestone: Merkelizing block data

      diff --git a/roadmap/codex/updates/2023-08-11.html b/roadmap/codex/updates/2023-08-11.html index 4b7954646..13f783667 100644 --- a/roadmap/codex/updates/2023-08-11.html +++ b/roadmap/codex/updates/2023-08-11.html @@ -1,5 +1,5 @@ -2023-08-11 Codex weekly

      Codex update August 11

      +2023-08-11 Codex weekly

      Codex update August 11


      Client

      Milestone: Merkelizing block data

      diff --git a/roadmap/codex/updates/index.html b/roadmap/codex/updates/index.html index a16300adc..9c1ed49e8 100644 --- a/roadmap/codex/updates/index.html +++ b/roadmap/codex/updates/index.html @@ -1,5 +1,5 @@ -Folder: roadmap/codex/updates

      1 items under this folder.