chore: converted Emoji version 16 (#2018)

* add language support for Comment

* docs: let users know they can customize their language preference

.github/dependabot.yml

@@ -1,11 +1,20 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
 version: 2
 updates:
   - package-ecosystem: "npm"
     directory: "/"
     schedule:
       interval: "weekly"
+    groups:
+      production-dependencies:
+        applies-to: "version-updates"
+        patterns:
+          - "*"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      ci-dependencies:
+        applies-to: "version-updates"
+        patterns:
+          - "*"

.github/workflows/build-preview.yaml

@@ -0,0 +1,43 @@
+name: Build Preview Deployment
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+  workflow_dispatch:
+
+jobs:
+  build-preview:
+    if: ${{ github.repository == 'jackyzha0/quartz' }}
+    runs-on: ubuntu-latest
+    name: Build Preview
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+
+      - run: npm ci
+
+      - name: Check types and style
+        run: npm run check
+
+      - name: Build Quartz
+        run: npx quartz build -d docs -v
+
+      - name: Upload build artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: preview-build
+          path: public

.github/workflows/ci.yaml

@@ -7,6 +7,7 @@ on:
   push:
     branches:
       - v4
+  workflow_dispatch:
 
 jobs:
   build-and-test:
@@ -18,17 +19,17 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
 
       - name: Cache dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -44,25 +45,25 @@ jobs:
         run: npm test
 
       - name: Ensure Quartz builds, check bundle info
-        run: npx quartz build --bundleInfo
+        run: npx quartz build --bundleInfo -d docs
 
   publish-tag:
-    if: ${{ github.repository == 'jackyzha0/quartz' }}
+    if: ${{ github.repository == 'jackyzha0/quartz' && github.ref == 'refs/heads/v4' }}
     runs-on: ubuntu-latest
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
       - name: Get package version
         run: node -p -e '`PACKAGE_VERSION=${require("./package.json").version}`' >> $GITHUB_ENV
       - name: Create release tag
-        uses: pkgdeps/git-tag-action@v2
+        uses: pkgdeps/git-tag-action@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           github_repo: ${{ github.repository }}

.github/workflows/deploy-preview.yaml

@@ -0,0 +1,37 @@
+name: Upload Preview Deployment
+on:
+  workflow_run:
+    workflows: ["Build Preview Deployment"]
+    types:
+      - completed
+
+permissions:
+  actions: read
+  deployments: write
+  contents: read
+  pull-requests: write
+
+jobs:
+  deploy-preview:
+    if: ${{ github.repository == 'jackyzha0/quartz' && github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    name: Deploy Preview to Cloudflare Pages
+    steps:
+      - name: Download build artifact
+        uses: actions/download-artifact@v4
+        id: preview-build-artifact
+        with:
+          name: preview-build
+          path: build
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          run-id: ${{ github.event.workflow_run.id }}
+
+      - name: Deploy to Cloudflare Pages
+        uses: AdrianGonz97/refined-cf-pages-action@v1
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          projectName: quartz
+          deploymentName: Branch Preview
+          directory: ${{ steps.preview-build-artifact.outputs.download-path }}

.github/workflows/docker-build-push.yaml

@@ -0,0 +1,88 @@
+name: Docker build & push image
+
+on:
+  push:
+    branches: [v4]
+    tags: ["v*"]
+  pull_request:
+    branches: [v4]
+    paths:
+      - .github/workflows/docker-build-push.yaml
+      - quartz/**
+  workflow_dispatch:
+
+jobs:
+  build:
+    if: ${{ github.repository == 'jackyzha0/quartz' }} # Comment this out if you want to publish your own images on a fork!
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set lowercase repository owner environment variable
+        run: |
+          echo "OWNER_LOWERCASE=${OWNER,,}" >> ${GITHUB_ENV}
+        env:
+          OWNER: "${{ github.repository_owner }}"
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      - name: Inject slug/short variables
+        uses: rlespinasse/github-slug-action@v5.1.0
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          install: true
+          driver-opts: |
+            image=moby/buildkit:master
+            network=host
+      - name: Install cosign
+        if: github.event_name != 'pull_request'
+        uses: sigstore/cosign-installer@v3.8.2
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        if: github.event_name != 'pull_request'
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata tags and labels on PRs
+        if: github.event_name == 'pull_request'
+        id: meta-pr
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ env.OWNER_LOWERCASE }}/quartz
+          tags: |
+            type=raw,value=sha-${{ env.GITHUB_SHA_SHORT }}
+          labels: |
+            org.opencontainers.image.source="https://github.com/${{ github.repository_owner }}/quartz"
+      - name: Extract metadata tags and labels for main, release or tag
+        if: github.event_name != 'pull_request'
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          flavor: |
+            latest=auto
+          images: ghcr.io/${{ env.OWNER_LOWERCASE }}/quartz
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}.{{minor}}.{{patch}}
+            type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
+            type=raw,value=sha-${{ env.GITHUB_SHA_SHORT }}
+          labels: |
+            maintainer=${{ github.repository_owner }}
+            org.opencontainers.image.source="https://github.com/${{ github.repository_owner }}/quartz"
+
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@v6
+        with:
+          push: ${{ github.event_name != 'pull_request' }}
+          build-args: |
+            GIT_SHA=${{ env.GITHUB_SHA }}
+            DOCKER_LABEL=sha-${{ env.GITHUB_SHA_SHORT }}
+          tags: ${{ steps.meta.outputs.tags || steps.meta-pr.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels || steps.meta-pr.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha

.node-version

@@ -0,0 +1 @@
+v22.16.0

Dockerfile

@@ -1,23 +1,11 @@
-FROM python:latest as convert
+FROM node:22-slim AS builder
-WORKDIR /usr/src/app
-COPY content/ ./
-COPY custom/convert-furigana/program/convert-furigana.py ./
-COPY custom/convert-usage/program/convert-usage.py ./
-ENV PIP_ROOT_USER_ACTION=ignore
-RUN python -m pip install --upgrade pip
-RUN python -m pip install beautifulsoup4
-RUN python convert-furigana.py .
-RUN python convert-usage.py .
-
-FROM node:20-slim as builder
 WORKDIR /usr/src/app
 COPY package.json .
 COPY package-lock.json* .
 RUN npm ci
 
-FROM node:20-slim
+FROM node:22-slim
 WORKDIR /usr/src/app
 COPY --from=builder /usr/src/app/ /usr/src/app/
 COPY . .
-COPY --from=convert /usr/src/app/ /usr/src/app/content/
 CMD ["npx", "quartz", "build", "--serve"]

content/.gitignore

@@ -1,2 +0,0 @@
-.obsidian/workspace.json
-0- Do-Not-Commit

content/.obsidian/app.json

@@ -1,4 +0,0 @@
-{
-  "alwaysUpdateLinks": true,
-  "showInlineTitle": false
-}

content/.obsidian/appearance.json

@@ -1,11 +0,0 @@
-{
-  "accentColor": "",
-  "theme": "moonstone",
-  "enabledCssSnippets": [
-    "usage",
-    "spacing",
-    "highlight-color"
-  ],
-  "cssTheme": "AnuPpuccin",
-  "showViewHeader": true
-}

content/.obsidian/community-plugins.json

@@ -1,6 +0,0 @@
-[
-  "obsidian-markdown-furigana",
-  "obsidian-style-settings",
-  "obsidian42-brat",
-  "obsidian-opener"
-]

content/.obsidian/core-plugins-migration.json

@@ -1,30 +0,0 @@
-{
-  "file-explorer": true,
-  "global-search": true,
-  "switcher": true,
-  "graph": true,
-  "backlink": true,
-  "canvas": true,
-  "outgoing-link": true,
-  "tag-pane": true,
-  "properties": false,
-  "page-preview": true,
-  "daily-notes": true,
-  "templates": true,
-  "note-composer": true,
-  "command-palette": true,
-  "slash-command": false,
-  "editor-status": true,
-  "bookmarks": true,
-  "markdown-importer": false,
-  "zk-prefixer": false,
-  "random-note": false,
-  "outline": true,
-  "word-count": true,
-  "slides": false,
-  "audio-recorder": false,
-  "workspaces": false,
-  "file-recovery": true,
-  "publish": false,
-  "sync": false
-}

content/.obsidian/core-plugins.json

@@ -1,20 +0,0 @@
-[
-  "file-explorer",
-  "global-search",
-  "switcher",
-  "graph",
-  "backlink",
-  "canvas",
-  "outgoing-link",
-  "tag-pane",
-  "page-preview",
-  "daily-notes",
-  "templates",
-  "note-composer",
-  "command-palette",
-  "editor-status",
-  "bookmarks",
-  "outline",
-  "word-count",
-  "file-recovery"
-]

content/.obsidian/graph.json

@@ -1,22 +0,0 @@
-{
-  "collapse-filter": true,
-  "search": "",
-  "showTags": false,
-  "showAttachments": false,
-  "hideUnresolved": false,
-  "showOrphans": true,
-  "collapse-color-groups": true,
-  "colorGroups": [],
-  "collapse-display": true,
-  "showArrow": false,
-  "textFadeMultiplier": 0,
-  "nodeSizeMultiplier": 1,
-  "lineSizeMultiplier": 1,
-  "collapse-forces": true,
-  "centerStrength": 0.518713248970312,
-  "repelStrength": 10,
-  "linkStrength": 1,
-  "linkDistance": 250,
-  "scale": 1,
-  "close": false
-}

content/.obsidian/plugins/obsidian-markdown-furigana/manifest.json

@@ -1,10 +0,0 @@
-{
-	"id": "obsidian-markdown-furigana",
-	"name": "Markdown Furigana",
-	"version": "1.3.0",
-	"minAppVersion": "0.9.12",
-	"description": "Simple Markdown to Furigana Rendering Plugin for Obsidian.",
-	"author": "Steven Kraft",
-	"authorUrl": "https://github.com/steven-kraft/obsidian-markdown-furigana",
-	"isDesktopOnly": false
-}

content/.obsidian/plugins/obsidian-opener/main.js

@@ -1,377 +0,0 @@
-/*
-THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
-if you want to view the source, please visit the github repository of this plugin
-*/
-
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// main.ts
-var main_exports = {};
-__export(main_exports, {
-  default: () => Opener
-});
-module.exports = __toCommonJS(main_exports);
-var import_obsidian2 = require("obsidian");
-
-// node_modules/monkey-around/mjs/index.js
-function around(obj, factories) {
-  const removers = Object.keys(factories).map((key) => around1(obj, key, factories[key]));
-  return removers.length === 1 ? removers[0] : function() {
-    removers.forEach((r) => r());
-  };
-}
-function around1(obj, method, createWrapper) {
-  const original = obj[method], hadOwn = obj.hasOwnProperty(method);
-  let current = createWrapper(original);
-  if (original)
-    Object.setPrototypeOf(current, original);
-  Object.setPrototypeOf(wrapper, current);
-  obj[method] = wrapper;
-  return remove;
-  function wrapper(...args) {
-    if (current === original && obj[method] === wrapper)
-      remove();
-    return current.apply(this, args);
-  }
-  function remove() {
-    if (obj[method] === wrapper) {
-      if (hadOwn)
-        obj[method] = original;
-      else
-        delete obj[method];
-    }
-    if (current === original)
-      return;
-    current = original;
-    Object.setPrototypeOf(wrapper, original || Function);
-  }
-}
-
-// settings.ts
-var import_obsidian = require("obsidian");
-var OpenerSettingTab = class extends import_obsidian.PluginSettingTab {
-  display() {
-    const { containerEl } = this;
-    const plugin = this.plugin;
-    containerEl.empty();
-    new import_obsidian.Setting(containerEl).setName("New Tab Default").setDesc(
-      "Enable to open new files in a new tab (or existing tab, if it was previously opened). Disable for default Obsidian behavior."
-    ).addToggle(
-      (toggle) => toggle.setValue(plugin.settings.newTab).onChange((value) => {
-        plugin.settings.newTab = value;
-        plugin.saveSettings();
-      })
-    );
-    new import_obsidian.Setting(containerEl).setName("PDF Default App").setDesc(
-      "Enable to open pdfs with system viewer app. Disable for default behavior (open pdfs in Obsidian)."
-    ).addToggle(
-      (toggle) => toggle.setValue(plugin.settings.PDFApp).onChange((value) => {
-        plugin.settings.PDFApp = value;
-        plugin.saveSettings();
-      })
-    );
-    new import_obsidian.Setting(containerEl).setName("Default app only when Ctrl/Cmd-Key is held").setDesc(
-      "Open in default app only when Ctrl/Cmd-Key is held. Disable to always\u201A open with system viewer."
-    ).addToggle(
-      (toggle) => toggle.setValue(plugin.settings.extOnlyWhenMetaKey).onChange((value) => {
-        plugin.settings.extOnlyWhenMetaKey = value;
-        plugin.saveSettings();
-      })
-    );
-    new import_obsidian.Setting(containerEl).setName("Open everything outside of Obsidian").setDesc(
-      "Enable to open all obsidian supported extensions with system viewer instead. Disable for default behavior (open within Obsidian). Defaults supported extensions are 'png', 'webp', 'jpg', 'jpeg', 'gif', 'bmp', 'svg', 'mp3', 'webm', 'wav', 'm4a', 'ogg','3gp', 'flac', 'mp4', 'ogv', 'mov', 'mkv'."
-    ).addToggle(
-      (toggle) => toggle.setValue(plugin.settings.allExt).onChange((value) => {
-        plugin.settings.allExt = value;
-        plugin.saveSettings();
-      })
-    );
-    new import_obsidian.Setting(containerEl).setName("Open Outside Obsidian: Manual List").setDesc("This shouldn't be necessary, but you can manually enable custom extensions here.").addToggle(
-      (toggle) => toggle.setValue(plugin.settings.custExt).onChange((value) => {
-        plugin.settings.custExt = value;
-        plugin.saveSettings();
-        this.display();
-      })
-    );
-    if (plugin.settings.custExt) {
-      new import_obsidian.Setting(containerEl).setName("Manual List").setDesc("Enter extension names (without the dot, ie, just docx separated by newlines).").addTextArea((textArea) => {
-        textArea.inputEl.rows = 5;
-        textArea.setValue(plugin.settings.custExtList.join("\n")).onChange(async (value) => {
-          plugin.settings.custExtList = value.split("\n");
-          plugin.saveSettings();
-        });
-      }).settingEl.style.borderTop = "none";
-    }
-  }
-};
-
-// constants.ts
-var DEFAULT_SETTINGS = {
-  newTab: true,
-  PDFApp: true,
-  extOnlyWhenMetaKey: true,
-  allExt: false,
-  custExt: false,
-  custExtList: []
-};
-
-// main.ts
-var Opener = class extends import_obsidian2.Plugin {
-  constructor() {
-    super(...arguments);
-    this.isMetaKeyHeld = null;
-    this.sameTabOnce = false;
-    // Meta key listeners
-    // arrow syntax to preserve `this` context
-    this.keyDownHandler = (e) => {
-      if (e.key === "Meta" || e.key === "Control") {
-        this.isMetaKeyHeld = true;
-      }
-    };
-    this.keyUpHandler = (e) => {
-      if (e.key === "Meta" || e.key === "Control") {
-        this.isMetaKeyHeld = false;
-      }
-    };
-    // Mouse handler is needed because the key handler will not fire if the app is out of focus
-    this.mouseDownHandler = (e) => {
-      if (e.metaKey || e.ctrlKey) {
-        this.isMetaKeyHeld = true;
-      } else {
-        this.isMetaKeyHeld = false;
-      }
-    };
-  }
-  async onload() {
-    console.log("loading " + this.manifest.name + " plugin");
-    await this.loadSettings();
-    this.addSettingTab(new OpenerSettingTab(this.app, this));
-    this.updateMetaKeyListeners();
-    this.monkeyPatchOpenFile();
-    this.addCommands();
-    this.addMenuItem();
-  }
-  onunload() {
-    this.uninstallMonkeyPatchOpenFile && this.uninstallMonkeyPatchOpenFile();
-    this.removeMetaKeyListeners();
-    console.log("unloading " + this.manifest.name + " plugin");
-  }
-  async loadSettings() {
-    const data = await this.loadData();
-    this.settings = Object.assign({}, DEFAULT_SETTINGS, data);
-  }
-  async saveSettings() {
-    await this.saveData(this.settings);
-    this.updateMetaKeyListeners();
-  }
-  addCommands() {
-    this.addCommand({
-      id: "same-tab-once",
-      name: "Open next file in same tab (Obsidian default behavior)",
-      checkCallback: (checking) => {
-        if (checking) {
-          return this.settings.newTab;
-        }
-        this.sameTabOnce = true;
-        new import_obsidian2.Notice("Next file will open in same tab");
-      }
-    });
-    this.addCommand({
-      id: "enable-new-tab",
-      name: "Enable new tab for all files",
-      checkCallback: (checking) => {
-        if (checking) {
-          return !this.settings.newTab;
-        }
-        this.settings.newTab = true;
-        this.saveSettings();
-        new import_obsidian2.Notice("Opener: New tab for all files enabled");
-      }
-    });
-    this.addCommand({
-      id: "disable-new-tab",
-      name: "Disable new tab for all files",
-      checkCallback: (checking) => {
-        if (checking) {
-          return this.settings.newTab;
-        }
-        this.settings.newTab = false;
-        this.saveSettings();
-        new import_obsidian2.Notice("Opener: New tab for all files disabled");
-      }
-    });
-    this.addCommand({
-      id: "enable-pdf",
-      name: "Enable open all PDFs with default app",
-      checkCallback: (checking) => {
-        if (checking) {
-          return !this.settings.PDFApp;
-        }
-        this.settings.PDFApp = true;
-        this.saveSettings();
-        new import_obsidian2.Notice("Opener: Open all PDFs with default app enabled");
-      }
-    });
-    this.addCommand({
-      id: "disable-pdf",
-      name: "Disable open all PDFs with default app",
-      checkCallback: (checking) => {
-        if (checking) {
-          return this.settings.PDFApp;
-        }
-        this.settings.PDFApp = false;
-        this.saveSettings();
-        new import_obsidian2.Notice("Opener: Open all PDFs with default app disabled");
-      }
-    });
-    this.addCommand({
-      id: "open-graph-view-in-new-tab",
-      name: "Open Graph View in new tab",
-      callback: () => {
-        this.app.commands.executeCommandById("workspace:new-tab");
-        this.app.commands.executeCommandById("graph:open");
-      }
-    });
-  }
-  // add command to right-click menu
-  addMenuItem() {
-    this.registerEvent(
-      this.app.workspace.on("file-menu", (menu, file, source, leaf) => {
-        if (file instanceof import_obsidian2.TFile) {
-          menu.addItem((item) => {
-            item.setSection("open");
-            item.setTitle("Open in same tab").onClick(() => {
-              this.sameTabOnce = true;
-              this.app.workspace.getLeaf().openFile(file);
-            });
-          });
-        }
-      })
-    );
-  }
-  addMetaKeyListeners() {
-    if (this.isMetaKeyHeld !== null)
-      return;
-    this.isMetaKeyHeld = false;
-    document.addEventListener("keydown", this.keyDownHandler);
-    document.addEventListener("keyup", this.keyUpHandler);
-    document.addEventListener("mousedown", this.mouseDownHandler, { capture: true });
-  }
-  removeMetaKeyListeners() {
-    if (this.isMetaKeyHeld === null)
-      return;
-    document.removeEventListener("keydown", this.keyDownHandler);
-    document.removeEventListener("keyup", this.keyUpHandler);
-    document.removeEventListener("mousedown", this.mouseDownHandler, { capture: true });
-    this.isMetaKeyHeld = null;
-  }
-  updateMetaKeyListeners() {
-    if (this.settings.extOnlyWhenMetaKey) {
-      this.addMetaKeyListeners();
-    } else {
-      this.removeMetaKeyListeners();
-    }
-  }
-  monkeyPatchOpenFile() {
-    const parentThis = this;
-    this.uninstallMonkeyPatchOpenFile = around(import_obsidian2.WorkspaceLeaf.prototype, {
-      openFile(oldOpenFile) {
-        return async function(file, openState) {
-          var _a, _b, _c, _d, _e, _f, _g, _h;
-          const defaultBehavior = () => {
-            return oldOpenFile.apply(this, [file, openState]);
-          };
-          const preparedEmptyLeave = ((_a = this.getViewState()) == null ? void 0 : _a.type) == "empty";
-          if (((_b = openState == null ? void 0 : openState.state) == null ? void 0 : _b.mode) && preparedEmptyLeave) {
-            return defaultBehavior();
-          }
-          if (file.path == ((_c = app.workspace.getActiveFile()) == null ? void 0 : _c.path) && ((_d = openState == null ? void 0 : openState.eState) == null ? void 0 : _d.subpath)) {
-            return defaultBehavior();
-          }
-          if (parentThis.sameTabOnce) {
-            parentThis.sameTabOnce = false;
-            return defaultBehavior();
-          }
-          const ALLEXT = ["png", "webp", "jpg", "jpeg", "gif", "bmp", "svg", "mp3", "webm", "wav", "m4a", "ogg", "3gp", "flac", "mp4", "ogv", "mov", "mkv"];
-          const OBSID_OPENABLE = ALLEXT.concat(["md", "canvas", "pdf"]);
-          if (parentThis.settings.PDFApp && file.extension == "pdf" || parentThis.settings.allExt && ALLEXT.includes(file.extension) || parentThis.settings.custExt && parentThis.settings.custExtList.includes(file.extension)) {
-            if (!parentThis.settings.extOnlyWhenMetaKey || parentThis.isMetaKeyHeld) {
-              new import_obsidian2.Notice("Opening external file with default app (Opener Plugin)");
-              if (preparedEmptyLeave) {
-                this.detach();
-              }
-              parentThis.app.openWithDefaultApp(file.path);
-              return;
-            } else {
-              new import_obsidian2.Notice("Opener Tip: Hold Cmd/Ctrl key to open with default app");
-            }
-          }
-          if (!parentThis.settings.newTab) {
-            return defaultBehavior();
-          }
-          if (this.group) {
-            new import_obsidian2.Notice("Opener: This is a Linked Tab! Opening in same tab therefore.");
-            return defaultBehavior();
-          }
-          const matchingLeaves = [];
-          const pushLeaveIfMatching = (leaf) => {
-            var _a2;
-            if (((_a2 = leaf.getViewState().state) == null ? void 0 : _a2.file) == file.path) {
-              matchingLeaves.push(leaf);
-            }
-          };
-          app.workspace.iterateRootLeaves(pushLeaveIfMatching);
-          (_g = (_f = (_e = app.workspace.getLayout()) == null ? void 0 : _e.floating) == null ? void 0 : _f.children) == null ? void 0 : _g.forEach((win) => {
-            var _a2;
-            if ((win == null ? void 0 : win.type) !== "window")
-              return console.log("Opener-Plugin: Strange floating object found (no window)", win);
-            (_a2 = win.children) == null ? void 0 : _a2.forEach((tabs) => {
-              var _a3;
-              if ((tabs == null ? void 0 : tabs.type) !== "tabs")
-                return console.log("Opener-Plugin: Strange floating object found (no tabs)", tabs);
-              (_a3 = tabs.children) == null ? void 0 : _a3.forEach((leaf) => {
-                if ((leaf == null ? void 0 : leaf.type) !== "leaf")
-                  return console.log("Opener-Plugin: Strange floating object found (no leaf)", leaf);
-                pushLeaveIfMatching(app.workspace.getLeafById(leaf.id));
-              });
-            });
-          });
-          if (matchingLeaves.length) {
-            if (preparedEmptyLeave) {
-              new import_obsidian2.Notice(`File is now open in ${matchingLeaves.length + 1} Tabs`);
-              return defaultBehavior();
-            } else {
-              return oldOpenFile.apply(matchingLeaves[0], [file, openState]);
-            }
-          }
-          if (preparedEmptyLeave) {
-            return defaultBehavior();
-          }
-          if (!((_h = parentThis.app.viewRegistry) == null ? void 0 : _h.getTypeByExtension(file.extension))) {
-            return defaultBehavior();
-          }
-          return oldOpenFile.apply(app.workspace.getLeaf("tab"), [
-            file,
-            openState
-          ]);
-        };
-      }
-    });
-  }
-};

content/.obsidian/plugins/obsidian-opener/manifest.json

@@ -1 +0,0 @@
-{"id":"obsidian-opener","name":"Opener","minAppVersion":"0.15.9","description":"Open links in new/existing tabs by default. Open PDFs in System App by default. Can open other file formats in System Apps if desired.","author":"Aidan Gibson","authorUrl":"https://github.com/aidan-gibson","isDesktopOnly":false,"version":"2.1.2"}

content/.obsidian/plugins/obsidian-style-settings/data.json

@@ -1,5 +0,0 @@
-{
-  "anuppuccin-theme-settings@@anuppuccin-theme-light": "ctp-latte",
-  "anuppuccin-theme-settings@@anuppuccin-light-theme-accents": "ctp-accent-light-lavender",
-  "anuppuccin-theme-settings@@anuppuccin-theme-accents": "ctp-accent-lavender"
-}

content/.obsidian/plugins/obsidian-style-settings/manifest.json

@@ -1,10 +0,0 @@
-{
-	"id": "obsidian-style-settings",
-	"name": "Style Settings",
-	"version": "1.0.8",
-	"minAppVersion": "0.11.5",
-	"description": "Offers controls for adjusting theme, plugin, and snippet CSS variables.",
-	"author": "mgmeyers",
-	"authorUrl": "https://github.com/mgmeyers/obsidian-style-settings",
-	"isDesktopOnly": false
-}

content/.obsidian/plugins/obsidian42-brat/data.json

@@ -1,16 +0,0 @@
-{
-  "pluginList": [
-    "aidan-gibson/obsidian-opener"
-  ],
-  "pluginSubListFrozenVersion": [],
-  "themesList": [],
-  "updateAtStartup": true,
-  "updateThemesAtStartup": true,
-  "enableAfterInstall": true,
-  "loggingEnabled": false,
-  "loggingPath": "BRAT-log",
-  "loggingVerboseEnabled": false,
-  "debuggingMode": false,
-  "notificationsEnabled": true,
-  "personalAccessToken": ""
-}

content/.obsidian/plugins/obsidian42-brat/manifest.json

@@ -1,15 +0,0 @@
-{
-	"id": "obsidian42-brat",
-	"name": "BRAT",
-	"version": "1.0.1",
-	"minAppVersion": "1.4.16",
-	"description": "Easily install a beta version of a plugin for testing.",
-	"author": "TfTHacker",
-	"authorUrl": "https://github.com/TfTHacker/obsidian42-brat",
-	"helpUrl": "https://tfthacker.com/BRAT",
-	"isDesktopOnly": false,
-	"fundingUrl": {
-		"Buy Me a Coffee": "https://bit.ly/o42-kofi",
-		"Visit my site": "https://tfthacker.com"
-	}
-}

content/.obsidian/plugins/obsidian42-brat/styles.css

@@ -1,3 +0,0 @@
-.brat-modal .modal-button-container {
-  margin-top: 5px !important;
-}

content/.obsidian/snippets/highlight-color.css

@@ -1,3 +0,0 @@
-.cm-s-obsidian span.cm-formatting-highlight, .cm-s-obsidian span.cm-highlight, .markdown-rendered mark {
-    --text-highlight-bg: #e6cee7;
-}

content/.obsidian/snippets/spacing.css

@@ -1,3 +0,0 @@
-.cm-s-obsidian .cm-line.HyperMD-header {
-    padding-top: 0;
-}

content/.obsidian/snippets/usage.css

@@ -1,39 +0,0 @@
-.usage {
-    display:flex;
-    flex-direction: row;
-    align-items: center;
-}
-
-.usage p {
-    margin:0;
-}
-
-.usage .box {
-    border: 1px solid black;
-    border-radius: 0.5rem;
-    padding: 0.2rem 0.3rem 0.2rem 0.3rem;
-    display: inline-block;
-    width: fit-content;
-    margin: 0.2rem;
-}
-
-.usage .left {
-    padding-right: 1.7rem;
-
-    background-image: linear-gradient(black, black), linear-gradient(black, black);
-    background-repeat: no-repeat;
-    background-size: 8px 2px;
-    background-position: top right, bottom right;
-
-    border-right: solid black;
-    border-width: 0 2px;
-}
-
-.usage .right {
-    padding-left: 1rem;
-}
-
-.usage .r {
-    margin-left: 0.25rem;
-    margin-right: 0.25rem;
-}

content/.obsidian/themes/AnuPpuccin/manifest.json

@@ -1,7 +0,0 @@
-{
-  "name": "AnuPpuccin",
-  "version": "1.4.5",
-  "minAppVersion": "0.16.0",
-  "author": "Anubis",
-  "authorUrl": "https://github.com/AnubisNekhet"
-}

content/Conjugation/Basics.md

@@ -1,65 +0,0 @@
-# Basics
-
-## う-verbs
-
-| Tense               | Dictionary positive | Dictionary negative | Polite positive | Polite negative |
-| ------------------- | ------------------- | ------------------- | --------------- | --------------- |
-| Present             | 書く                  | 書かない                | 書きます            | 書きません           |
-| Past                | 書いた                 | 書かなかった              | 書きました           | 書きませんでした        |
-| Volitional          | 書こう                 | 書かないだろう             | 書きましょう          | 書かないでしょう        |
-| Present Progressive | 書いている               | 書いていない              | 書いています          | 書いていません         |
-| Past Progressive    | 書いていた               | 書いていなかった            | 書いていました         | 書いていませんでした      |
-| Imperative          | 書け                  | 書けな                 | 書いてください         | 書かないでください       |
-| Conditional -eba    | 書けば                 | 書かなければ              | /               | /               |
-| Conditional -tara   | 書いたら                | 書かなかったら             | /               | /               |
-| Potential           | 書ける                 | 書けない                | 書けます            | 書けません           |
-| Causative           | 書かせる                | 書かせない               | 書かせます           | 書かせません          |
-| Passive             | 書かれる                | 書かれない               | 書かれます           | 書かれません          |
-
-## る-verbs
-
-| Tense               | Dictionary positive | Dictionary negative | Polite positive | Polite negative |
-| ------------------- | ------------------- | ------------------- | --------------- | --------------- |
-| Present             | 食べる                 | 食べない                | 食べます            | 食べません           |
-| Past                | 食べた                 | 食べなかった              | 食べました           | 食べませんでした        |
-| Volitional          | 食べよう                | 食べないだろう             | 食べましょう          | 食べませんでしょう       |
-| Present Progressive | 食べている               | 食べていない              | 食べています          | 食べていません         |
-| Past Progressive    | 食べていた               | 食べていなかった            | 食べていました         | 食べていませんでした      |
-| Imperative          | 食べろ                 | 食べるな                | 食べてください         | 食べないでください       |
-| Conditional -eba    | 食べれば                | 食べなければ              | /               | /               |
-| Conditional -tara   | 食べたら                | 食べなかったら             | /               | /               |
-| Potential           | 食べられる               | 食べられない              | 食べられます          | 食べられません         |
-| Causative           | 食べさせる               | 食べさせない              | 食べさせます          | 食べさせません         |
-| Passive             | 食べられる               | 食べられない              | 食べられます          | 食べられません         |
-
-## Irregular: する
-
-| Tense               | Dictionary positive | Dictionary negative | Polite positive | Polite negative |
-| ------------------- | ------------------- | ------------------- | --------------- | --------------- |
-| Present             | する                  | しない                 | します             | しません            |
-| Past                | した                  | しなかった               | しました            | しませんでした         |
-| Volitional          | しよう                 | しないだろう              | しましょう           | しませんでしょう        |
-| Present Progressive | している                | していない               | しています           | していません          |
-| Past Progressive    | していた                | していなかった             | していました          | していませんでした       |
-| Imperative          | しろ                  | するな                 | してください          | しないでください        |
-| Conditional -eba    | すれば                 | しなければ               | /               | /               |
-| Conditional -tara   | したら                 | しなかったら              | /               | /               |
-| Potential           | できる                 | できない                | できます            | できません           |
-| Causative           | させる                 | させない                | させます            | させません           |
-| Passive             | される                 | されない                | されます            | されません           |
-
-## Irregular: 来る
-
-| Tense               | Dictionary positive | Dictionary negative | Polite positive | Polite negative |
-| ------------------- | ------------------- | ------------------- | --------------- | --------------- |
-| Present             | くる                  | こない                 | きます             | きません            |
-| Past                | きた                  | こなかった               | きました            | きませんでした         |
-| Volitional          | きよう                 | こないだろう              | きましょう           | きませんでしょう        |
-| Present Progressive | きている                | きていない               | きています           | きていません          |
-| Past Progressive    | きていた                | きていなかった             | きていました          | きていませんでした       |
-| Imperative          | こい                  | くるな                 | きてください          | こないでください        |
-| Conditional -eba    | くれば                 | こなければ               | /               | /               |
-| Conditional -tara   | きたら                 | こなかったら              | /               | /               |
-| Potential           | こられる                | こられない               | こられます           | こられません          |
-| Causative           | こさせる                | こさせない               | こさせます           | こさせません          |
-| Passive             | こられる                | こられない               | こられます           | こられません          |

content/Conjugation/TeF (1) - basics.md

@@ -1,230 +0,0 @@
-# Te-Form (1) - basics
-
-## Rule
-
-### Verbs
-
-The easiest way to identify whether to use て or で is by looking at the preceding kana.
-If the plain (dictionary) form of the verb finishes in ぐ, ぬ, ぶ, or む, then で will be used.
-る-Verbs never use で.
-
-| Ending              | Ending Te-Form | Verb           | Te-Form                       | Hiragana            |
-| ------------------- | -------------- | -------------- | ----------------------------- | ------------------- |
-| **る verbs**         |                |                |                               |                     |
-| (い・え)る              | て              | 食べる            | 食べ==て==                       | たべて                 |
-| **う verbs**         |                |                |                               |                     |
-| う<br>つ<br>る         | <br>って<br>     | 歌う<br>打つ<br>座る | 歌==って==<br>打==って==<br>座==って== | うたって<br>うって<br>すわって |
-| む<br>ぶ<br>ぬ         | <br>んで         | 休む<br>飛ぶ<br>死ぬ | 休==んで==<br>飛==んで==<br>死==んで== | やすんで<br>とんで<br>しんで  |
-| く                   | いて             | 歩く             | 歩==いて==                       | あるいて                |
-| ぐ                   | いで             | 泳ぐ             | 泳==いで==                       | およいで                |
-| す                   | して             | 話す             | 話==して==                       | はなして                |
-| **Irregular Verbs** |                |                |                               |                     |
-|                     |                | する             | し==て==                        |                     |
-|                     |                | 行く             | 行==って==                       | いって                 |
-|                     |                | 来る             | 来==て==                        | きて                  |
-
-### Adjectives and nouns
-
-| Form                 | Word  | Word Te-Form |
-| -------------------- | ----- | ------------ |
-| **いA** + ~~い~~ く + て | おもしろい | おもしろ==くて==   |
-| **なA** + で           | しずか   | しずか==で==     |
-| **N** + で            | 猫     | 猫==で==       |
-
-### Song
-
-A common way to remember this form is by a song. Here is one sung by Hatsune Miku.
-
-![Te Song](https://www.youtube.com/watch?v=Cj-P-nEPoe0)
-
-| Ending | Te-Form |
-| ------ | ------- |
-| う・つ・る  | って      |
-| む・ぶ・ぬ  | んで      |
-| く      | いて      |
-| ぐ      | いで      |
-| いく     | いって     |
-| くる     | きて      |
-| する     | して      |
-| す      | して      |
-
-## Basic functions
-
-### Connection
-
-The most basic function of the Te-Form: form connection between **verbs**.
-
-> [!info] Example
-> 食べ==て=={寝|ね}る。
-> To eat, then sleep.
-
-This also works with **いA**, **なA**, and **nouns**.
-
-> [!info] Example
-> あの{自転車|じてんしゃ}は{便利|べんり}==で=={軽|かる}い。
-> That bicycle is useful and light.
-
-### Reasons
-
-Used primarily for reasons beyond control of the speaker.
-
-> [!info] Example
-> 大雨==で==バスが止まりました。
-> The bus stopped with rain. (the reason is the rain)
-
-### Manners
-
-Highlights something being used, whether a tool, a circumstance, a situation, etc.
-
-> [!info] Examples
-> 私はご{飯|はん}を{急|いそ}い==で==食べる。
-> I eat food in a hurry.
-> 
-> ハサミ==で=={野菜|やさい}を{切|き}ります。
-> I cut my vegetables using scissors.
-
-## Sequence and non-sequence
-
-Only for **verbs**.
-
-### て sequence
-
-Used to list a sequence of events that happen one after another. Must be used for ordered sequence of what is being said!
-
-> [!info] Example
-> パンを買==って==、食べた。
-> I bought some bread, then ate it.
-
-### て non-sequence
-
-The particle can also contrast things that have some sort of relationship. It can mean something like "and" or "while", but is not really similar to "but": it always has the same weight in the sentence, as opposed to expressions like けど・のに, etc.
-
-> [!info] Examples
-> 朝は雨が{降|ふ}==って=={夕方|ゆう|がた}は{晴|は}れた。
-> It rained this morning, **and** then it cleared up in the afternoon. (there is no particular emphasis on either event).
->
-> 朝は雨が降った==けど==夕方は晴れた。
-> It rained this morning, **but then** it cleared up in the afternoon. (there is emphasis on the fact that it stopped raining).
-
-### てから
-
-Used to say that something will happen after something else : "after doing (A), (B)".
-Only for **verbs**.
-
-> [!info] Example
-> {洗濯|せん|たく}をし==てから==、出かける。
-> After doing the laundry, I will go out.
-
-⚠ Simple present (るから) and past (たから) have a meaning closer to "because" or "since".
-
-## States
-
-### ている form
-
-| Plain | Polite |
-| ----- | ------ |
-| ている   | ています   |
-| てる    | てます    |
-
-ている is often shortened to てる. This applies to all tenses, including てる, てて, てた, and even てます.
-Only for **verbs**.
-
-Sometimes ている can become しとる (like in manga).
-
-#### 1/ State of existence: is being done
-
-Used to convey a constant state of the verb being done, executed, etc. It is continuing to exist in a specific state.
-
-> [!info] Example
->今ラーメンを食べ==ています==。
->I am eating ramen now.
-
-#### 2/ State of existence: has been done
-
-Expresses "existing in a of state of having been done".
-In English, a different tense would have been used, but in Japanese it is also Te-form.
-
-> [!info] Examples
-> お前はもう死==んでいる==。
-> You are already dead.
-> 
-> クラスは始ま==っている==。
-> The class has already started. (existing in the state of having started)
-> 
-> お母さんは今買い物に行==っています==。
-> My mom went out to go shopping. (existing in the state of having gone)
-> 
-> 先生がめちゃ{怒|おこ}==っている==。
-> My teacher is very angry. (existing in the state of having gotten angry)
-
-Then, how to differentiate from the past form? Think about if the action can happen twice. For example, something cannot start twice, so it will use ている. The same applies for dying. This will not work for all verbs, but for the majority.
-
-> [!info] Example
-> ピアノが{落|お}ち==ている==。
-> The piano has fallen. (existing in the state of having fallen)
-> Something has fallen and is already on the ground, so it cannot fall again. ている will be used.
-
-#### 3/ State of existence: frequent and repeated action
-
-Used for the repetition of common activities. They are not continuing per se, but are occurring at such a frequency that they are considered to be continuous.
-For example: going to work, having a hobby, doing sports, etc.
-
-You can see it as "continuing to exist in a specific state".
-Expression of time are often used with this meaning.
-
-> [!info] Examples
-> 私は毎日ギターを{弾|ひ}い==ている==。
-> I play my guitar everyday (hobby).
-> 
-> {毎晩|まい|ばん}９時に{寝|ね}==ている==。
-> I sleep at 9 every night (habit).
-> 
-> {彼|かれ}は学校で{働|はたら}い==ている==。
-> He works at a school (regular activity).
-
-### ていた・ていました
-
-Means that something was happening, someone was doing something. If an object has changed state and is still in the state, it can also be used, for example a broken window.
-Only for **verbs**.
-
-ていた can be shortened to てた, and ていました to てました.
-
-> [!info] Example
-> {勉強|べんきょう}をし==ていた==けど、今は{休|やす}んでいる。
-> I was studying but am taking a break right now.
-
-### てある
-
-Shares with ている the meaning of being in an ongoing state, meaning that something has been done. It is also similar to a simple past form. However, the nuance is that this form is only used with transitive verbs on inanimate objects, meaning either:
-* the action has been done intentionally (focuses on a person's intention),
-* the focus is the resulting state of the action.
-
-> [!info] Examples
-> 明日の{弁当|べん|とう}はもう作==ってある==。
-> Tomorrow's lunch has already been prepared.
-> 
-> ドアが{開|あ}け==てある==。
-> The door has been left open (intentionally).
-
-Only for **transitive verbs**.
-
-### ておく
-
-Means to do something in advance, to complete something in preparation for something.
-If used in past form ておいた, means that the completed action was in preparation for the current situation.
-Only for **verbs**.
-
-Can be shortened as とく.
-
-> [!info] Example
-> メロンパンを買==っておく==。
-> I'll buy a melon pan (in preparation for a something, for example a picnic).
-
-### まだ～ていません
-
-This means "still have not done something". 
-Only for **verbs**.
-
-> [!info] Example
-> このゲームは==まだ==し==ていない==。
-> I haven't played this game yet.

content/Conjugation/TeF (2) - manner of doing.md

@@ -1,86 +0,0 @@
-# Te-Form (2) - manner of doing
-
-## ていく・てくる
-
-ていく combines the Te-form with the verb 行く.
-てくる combines the Te-form with the verb 来る. 
-Both can be used when representing time or a physical place. Kanji and hiragana can be used, and they can be conjugated.
-Only for **verbs**.
-
-The first meaning is the following:
-* ていく means to go and do something.
-* てくる means to do and come back.
-
-> [!info] Examples
-> 家で食べ==ていく==か？
-> Want to go and eat at my home?
-> 
-> {晩御飯|ばんごはん}を買==ってきた==。
-> I brought tonight's dinner. (bought and came with).
-
-The second meaning is:
-* ていく means to start doing something with your own agency.
-* てくる on the contrary, is when something comes to the listener without agency from them.
-
-> [!info] Examples
-> 彼は駅まで歩い==ていきます==。
-> He walk to the station.
-> 
-> 雨が{降|ふ}==ってきた==。
-> It started raining.
-
-## てしまう・ちゃう・じゃう
-
-<div class="usage">
-<div>
-	<p><span class="box">Vて</span> + しまう</p>
-	<p><span class="box">V<strike>て</strike></span> + ちゃう</p>
-	<p><span class="box">V<strike>で</strike></span> + じゃう</p>
-</div>
-</div>
-
-This means "by accident, unfortunately" or "completely".
-Only for **verbs**.
-
-> [!info] Examples
-> {宿題|しゅく|だい}もうや==ってしまいました==。
-> I've already finished my homework.
-> 
-> もう{全部|ぜん|ぶ}食べ==ちゃった==。。。
-> I've already eaten everything...
-
-## てみる
-
-Used to express the meaning of trying something, usually something new.
-Can also be used to suggest to someone to try something.
-Used in past tense, it implies a successful attempt.
-Only for **verbs**.
-
-> [!info] Example
-> これを食べ==てみる==か？
-> Do you want to try this food?
-
-## てすみません
-
-Means "sorry for".
-
-> [!info] Example
-> {遅|おく}れ==てすみません==。
-> Sorry for being late.
-
-## てよかった
-
-Means "glad that".
-
-> [!info] Example
-> {美術館|びじゅつかん}に行==ってよかった==。
-> I'm glad I went to the museum.
-
-## ているところ
-
-Means "in the process/middle of doing". Can either talk about the exact moment or in general.
-See also [[🔰 Grammar/Time#たところ]].
-
-> [!info] Example
-> {現在|げんざい}、{求職|きゅうしょく}し==ているところ==です。
-> I am currently seeking a job.

content/Conjugation/TeF (3) - give & receive.md

@@ -1,56 +0,0 @@
-# Te-Form (3) - give & receive
-
-Extends the common forms of あげる, くれる, and もらう, but what is received or given is now a verb, instead of a noun.
-
-## てあげる
-
-Expresses that someone is doing or did something for someone else.
-The person that received the favor is followed by the に particle.
-Only for **verbs**.
-
-> [!info] Example
-> 母にケーキを買==ってあげた==。
-> I bought a cake for my mother.
-> 
-
-For casual language, ==てやる== can be used.
-
-## てくれる
-
-Used to ask a favor from someone or to say that something was done to the speaker.
-The person that received the favor (usually oneself and thus omitted) is followed by the に particle.
-Only for **verbs**.
-
-> [!info] Example
-> {友達|とも|だち}がギターを{教|おし}え==てくれる==。
-> My friend will teach me the guitar.
-
-### てくれてありがとう
-
-This form expresses gratitude for something that benefited the speaker. It is not used for something expected.
-Only for **verbs**.
-
-> [!info] Example
-> 今日来==てくれてありがとう==！
-> Thank you for coming today!
-
-## てもらう
-
-This form expresses gratitude for a favor that the recipient generally requested for, or where gratitude is the focus.
-Only for **verbs**.
-
-> [!info] Example
-> {友達|とも|だち}が手伝==ってもらった==。
-> My friend helped me (and I owe him / because I asked him and I am grateful)
-
-## てくれない・てもらえない
-
-Used as a mean to ask for a favor like "would you, could you?". Used in a similar form to じゃないか.
-Only for **verbs**.
-
-> [!info] Example
-> {電気|でん|き}をつけ==てもらえない==か。
-> Could you please turn on the lights?
-> 
-> 電気をつけ==ないでもらえない==か。
-> Could you please turn off the light?

content/Conjugation/TeF (4) - even if.md

@@ -1,69 +0,0 @@
-# Te-Form (4) - even if
-
-For **verbs**, **adjectives** and **nouns**.
-
-## Even if: ても・でも
-
-Works by adding も to the Te-Form.
-
-> [!info] Example
-> 安==くても==、買いません。
-> Even if it's cheap, I won't buy it.
-> 
-> 好き==でも==、買えなかった。
-> Even if I liked it, I didn't bought it.
-
-### てもいい
-
-Means that something is "alright". Frequently used for questions.
-
-> [!info] Example
-> ここに{座|すわ}==ってもいい==？
-> Is it okay if I sit here?
-> 
-> {冷|つめ}たい==でもいい==。
-> It's okay even if it's cold.
-
-### ても～なくても
-
-Means "whether or not". A form a bit strange, where the verb is repeated two times in the following manner: VてもVなくても.
-
-> [!info] Example
-> 食べ==ても==食べ==なくても==、{構|かま}いません。
-> It doesn't matter whether you eat it orb not.
-
-### ても構わない・てもかまわない
-
-Means that it doesn't matter or that the speaker doesn't mind.
-
-> [!info] Example
-> 雨が{降|ふ}==っても構わない==。
-> I don't mind if it rains.
-
-### ても始まらない・てもはじまらない
-
-Means that even if you do it, it will never start: that it's no use.
-Only for **verbs**.
-
-> [!info] Example
-> この時間に会==っても始まらない==。
-> There's no point meeting at this time of the day.
-
-### いくら～ても・どんなに～ても
-
-Means "no matter how much".
-
-> [!info] Example
-> ==いくら==好き==でも==、買えません。
-> No matter how much you like it, I won't buy it for you.
-> 
-> ==どんなに==高==くても==、買います。
-> No matter how expensive, I'll buy it.
-
-### たとえ〜ても
-
-Used to make a supposition. Would translate to something like "even if... is the case".
-
-> [!info] Example
-> ==たとえ=={新幹線|しん|かん|せん}==でも==、１時間かかる。
-> Even if you take the Shinkansen, it will take one hour.

content/index.md

@@ -1,52 +0,0 @@
-# Japanese Grammar
-
-Welcome to my Japanese Grammar project!
-
-## Goal
-
-The goal of this website is to be a synthesis of useful resources for my Japanese learning adventure. I want to have grammar points next to each other, independently of any "difficulty level", set up in a logical and consistent form. I don't want to have to open 5 pages to compare information, and I don't want a deep dive into a notion. The goal is to be a reminder of the things I learn, rather than a way to learn. I want a few examples to grasp it, but I do not want to have ten of the same kind. And nothing quite fits for me!
-
-## Sources
-
-Of course, since I'm _learning_ the language, I need to borrow what I write from different sources. So this website uses data from the websites listed here. I don't want any recognition of what is here! It's mostly a compilation of what people who are way better in this language have made before.
-
-* [Bunpro](https://bunpro.jp/grammar_points)
-* [JLPT Sensei](https://jlptsensei.com/#jlpt-grammar-lists)
-* [Maggie Sensei](https://maggiesensei.com/)
-* [Try! Series of books](https://2024.ask-books.com/tag/try/)
-* [Hedgehog Japanese](https://hedgehog-japanese.com/category/grammar/)
-* [Wasabi](https://www.wasabi-jpn.com/category/japanese-grammar/)
-* [Japanese StackExchange](https://japanese.stackexchange.com/)
-* [Guide du Japonais](https://guidedujaponais.fr/)
-* [Tofugu](https://www.tofugu.com)
-* [Imabi](https://imabi.org/table-of-contents-%e7%9b%ae%e6%ac%a1/)
-* [Tae-Kim's Guide](https://guidetojapanese.org/learn/)
-
-## Other useful resources
-
-In addition to those I cited, here are other resources I find useful.
-
-### Kanjis
-
-* [Remembering the Kanji (RTK)](https://en.wikipedia.org/wiki/Remembering_the_Kanji_and_Remembering_the_Hanzi), a kanji learning method
-* [Kanji Koohii](https://kanji.koohii.com/), a website using the RTK method and spaced repetition
-* [Remember the JLPT](https://git.marchal.dev/keb/remember-the-JLPT), a tool I made to learn kanjis by JLPT levels
-
-### Reading
-
-* [Sakubun](https://sakubun.xyz/)
-* [NHK News Web Easy](https://www3.nhk.or.jp/news/easy/)
-
-### Grammar
-
-* [jtest4you](https://japanesetest4you.com/)
-* [Japanese Conjugation Drill](https://drill.jp.marchal.dev)
-
-### Vocabulary
-
-* [Jisho](https://jisho.org/), an online dictionary
-* [Tangorin](https://tangorin.com/sentences), for its sentences database
-
-## Any errors?
-
-If you find any error, please do contact me! You can find my website in the footer of any page of this website. Thanks!

content/🔰 Grammar/Actions.md

@@ -1,116 +0,0 @@
-# Actions
-
-## になる
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">い-Adj + <strike>い</strike> + く</span></p>
-	<p><span class="box">な-Adj + に</span></p>
-	<p><span class="box">N + に</span></p>
-</div>
-	<p class="right">+ なる</p>
-</div>
-
-Means "to become".
-
-> [!info] Example
-> {新幹線|しんかんせん}==になりたい==！
-> I want to become a bullet train!
-
-## にする
-
-### To decide
-
-Means "to decide".
-Used with nouns.
-
-> [!info] Example
-> このレストラン==にしました==。
-> I've decided on this restaurant.
-
-### Make something
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">い-Adj + <strike>い</strike> + く</span></p>
-	<p><span class="box">な-Adj + に</span></p>
-</div>
-	<p class="right">+ なる</p>
-</div>
-
-Means to "make something more".
-
-> [!info] Example
-> ストーブを{点|つ}けて{部屋|へや}を{暑|あつ}==くする==。
-> Turn on the heater to make the room hotter.
-
-## ようになる
-
-Means "to reach a point". Used with verbs.
-
-> [!info] Example
-> この本{全部|ぜんぶ}{分|わ}かる==ようになった==。
-> I've come to understand all of this book.
-
-## ようにする
-
-Means "to try to", "to make sure to".
-Used with a verb.
-
-> [!info] Example
-> 毎日に{朝|あさ}ご{飯|はん}を食べる==ようとします==。
-> I'll try to eat a breakfast everyday.
-
-## に気がつく
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V + こと</span></p>
-	<p><span class="box">N</span></p>
-</div>
-	<p class="right">+ に気がつく</p>
-</div>
-
-に{気|き}がつく means "to notice", "to realize".
-
-> [!info] Example
-> {新|あたら}しいレストランが{開店|かい|てん}==に気がついた==。
-> I noticed a new restaurant opened.
-
-## と思う
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + だ</span></p>
-	<p><span class="box">N + だ</span></p>
-</div>
-	<p class="right">+ と思う</p>
-</div>
-
-と{思|おも}う means "to think".
-
-> [!info] Example
-> {変|へん}だ==と思わない==か。
-> Don't you think it's strange?
-> 
-> 今日は{公園|こう|えん}に行く==と思います==。
-> I think I'll go to the park today.
-
-## すぎる
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V <strike>ます</strike></span></p>
-	<p><span class="box">い-Adj <strike>い</strike></span></p>
-	<p><span class="box">な-Adj</span></p>
-</div>
-	<p class="right">+ すぎる</p>
-</div>
-
-Means "too much", "exceeding".
-
-> [!info] Example
-> {昨晩|さく|ばん}に{飲|の}み==すぎて=={頭|あたま}が{痛|いた}い。
-> I drank too much last night and my head hurts.

content/🔰 Grammar/Adverbs.md

@@ -1,45 +0,0 @@
-# Adverbs
-
-## さすが
-
-<div class="usage">
-<div class="">
-	<p><span class="box">さすが</span></p>
-</div>
-	<p class="r">+ に + V</p>
-</div>
-<div class="usage">
-<div class="">
-	<p><span class="box">さすが</span></p>
-</div>
-	<p class="r">+ の + N</p>
-</div>
-
-Means "as expected".
-
-> [!info] Example
-> ==さすが==のオランダ人、{自転車|じてんしゃ}で{通|かよ}う。
-> As expected of a Dutch, they commute by bicycle.
-
-## そんなに
-
-Means "so much" or "like that".
-Not used with nouns.
-
-⚠ It is applied to the following word, not the preceding one.
-
-> [!info] Example
-> {僕|ぼく}は{卵|たまご}が==そんなに==好きじゃない。
-> I don't like eggs that much.
-
-## なかなか～ない
-
-This form means that an effort has been made, but no outcome happens. Can be translated as "not easy to", "not able to", "hardly", "not at all".
-This form is used with a verb in the negative form (ない).
-
-> [!info] Example
-> 雨だから、==なかなか==タクシーが来てい==ません==。
-> Because of the rain, it's not easy to get a taxi.
-> 
-> ==なかなか==お酒止めるでき==ない==。
-> It is not easy to stop drinking.

content/🔰 Grammar/Advice - Guidance.md

@@ -1,19 +0,0 @@
-# Advice & guidance
-
-## たらどう
-
-Used to ask about a situation, usually to give advice. Translates to "why don't you" or "how about".
-Used with the たら form of verbs.
-
-> [!info] Example
-> ゲームをし==たらどう==か。
-> How about you play a game?
-
-## たらいいですか
-
-Used to ask about an advice or instructions. Translates to "what should I do".
-Used with the たら form of verbs.
-
-> [!info] Example
-> 何を{飲|の}ん==だらいいですか==。
-> What should I drink?

content/🔰 Grammar/Combination actions.md

@@ -1,65 +0,0 @@
-# Combination actions
-
-Those rules combine a verb and an adjective to make a new meaning.
-
-<div class="usage">
-<div class="">
-	<p><span class="box">V-<strike>ます</strike></span></p>
-</div>
-	<p class="r">+ Adj</p>
-</div>
-
-## ~やすい
-
-Means: 
-* easy to do
-* likely to happen
-* has a tendency of
-
-> [!info] Example
-> 見==やすい==。
-> Easy to see.
-> 
-> {泣|な}き==やすい==。
-> Prone to crying.
-
-## ~にくい・~づらい
-
-Means that something is difficult to do.
-While にくい is the broader form, づらい is used in a more subjective manner, for actions that are intentional.
-
-> [!info] Example
-> 見==にくい==。
-> Difficult to see.
-
-## ~始める
-
-～{始|はじ}める means that something starts or has started. Expresses intentionality.
-
-> [!info] Example
-> {飲|の}み==始める==。
-> To start to drink.
-
-## ~出す
-
-～{出|だ}す means that something suddenly started. Has the nuance of being unintentional, or cannot be avoided.
-
-> [!info] Example
-> 雨が降り==出した==。
-> It suddenly started raining.
-
-## ~続く
-
-～{続|つづ}く means that something continues.
-
-> [!info] Example
-> {飲|の}み==続ける==。
-> To continue to drink.
-
-## ~終わる
-
-～{終|お}わる means that something ends.
-
-> [!info] Example
-> {飲|の}み==終わります==。
-> To stop to drink.

content/🔰 Grammar/Comparison.md

@@ -1,59 +0,0 @@
-# Comparison
-
-## より
-
-With the following pattern, it means that A is "more" Adj than B.
-
-<div class="usage">
-	<p class="r">AはB +</p>
-<div class="">
-	<p><span class="box">より</span></p>
-</div>
-	<p class="r">+ Adj + です</p>
-</div>
-
-> [!info] Example
-> 電車は車==より=={速|はや}いです。
-> Trains are faster than cars.
-
-## より～ほうが
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ ほうが</p>
-</div>
-
-With the following pattern, it means that B is more than A:
-<div class="usage">
-	<p class="r">A +</p>
-<div class="">
-	<p><span class="box">より</span></p>
-</div>
-	<p class="r">+ B +</p>
-<div class="">
-	<p><span class="box">ほうが</span></p>
-</div>
-</div>
-
-より indicates the lesser thing, and {方|ほう}が the greater thing.
-
-> [!info] Example
-> 昨日==より==今日の==ほうが==寒いです。
-> Today is colder than yesterday.
-
-## ほうがいい
-
-Means "should", or "it would be better", as an advice. It's better than not doing it.
-Used with a verb.
-
-> [!info] Example
-> 毎日{練習|れんしゅう}する==ほうがいい==。
-> It's better to train everyday.
-
-
-

content/🔰 Grammar/Conditional.md

@@ -1,109 +0,0 @@
-# Conditional
-
-## と
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + だ</span></p>
-	<p><span class="box">N + だ</span></p>
-</div>
-	<p class="right">+ と</p>
-</div>
-
-Means "if" when a result is known or assumed to be true, aka a logical cause-effect relationship. Cannot be used if the result is uncertain. So it cannot be an intention, a request, a desire, an order, etc.
-
-> [!info] Example
-> {急|いそ}いでない==と==、{遅刻|ちこく}に{着|つ}きます。
-> If you don't hurry, you'll arrive late.
-
-## なら
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual) + (の)</span></p>
-	<p><span class="box">い-Adj + (の)</span></p>
-	<p><span class="box">な-Adj + (の)</span></p>
-	<p><span class="box">N</span></p>
-</div>
-	<p class="right">+ なら</p>
-</div>
-
-Means "in the case that/of". The second part of the sentence is generally an opinion, a request or a suggestion.
-Adding の adds emphasis.
-
-> [!info] Example
-> 車を使う==なら==、気を{付|つ}けて。
-> If you're using a car, be careful.
-
-## えば・なければ
-
-Positive form:
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (う -> え)</span></p>
-	<p><span class="box">い-Adj + けれ</span></p>
-	<p><span class="box">な-Adj + なら</span></p>
-	<p><span class="box">N + なら</span></p>
-</div>
-	<p class="right">+ ば</p>
-</div>
-
-Negative form:
-<div class="usage">
-<div class="left">
-	<p><span class="box">V <strike>ない</strike></span></p>
-	<p><span class="box">い-Adj <strike>ない</strike></span></p>
-	<p><span class="box">な-Adj + で</span></p>
-	<p><span class="box">N + で</span></p>
-</div>
-	<p class="right">+ なければ</p>
-</div>
-
-See Conjugation [[Basics]] for verbs (the う sound transforms the the corresponding え sound).
-
-Means "if". A conditional relationship without the cause-effect relationship of と.
-
-> [!info] Examples
-> 雨が止==めれば==、店に行く。
-> If it stops raining, I'll go to the store.
-> 
-> おいしい==でなければ==、食べません。
-> If it's not good, I will not eat it.
-
-## たら
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (た)</span></p>
-	<p><span class="box">い-Adj <strike>い</strike> + かった</span></p>
-	<p><span class="box">な-Adj + だった</span></p>
-	<p><span class="box">N + だった</span></p>
-</div>
-	<p class="right">+ ら</p>
-</div>
-
-Means "if" or "when". Describes a condition (the first action must be completed before the second action). Usually used for hypothetical situations. It is the main word used for conditional.
-
-> [!info] Example
-> 安==かったら==、買う。
-> (If / When) it's cheap, I'll buy it.
-
-## 場合
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual)</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ 場合は</p>
-</div>
-
-{場合|ば|あい} means "in the case of". The second part explains what to do in the situation (instructions, advices, etc). More formal than たら.
-
-> [!info] Example
-> {地震|じ|しん}==の場合は==、エレベーターを使わないでください。
-> In case of an earthquake, please don't use the elevators.

content/🔰 Grammar/Connectors.md

@@ -1,73 +0,0 @@
-# Connectors (conjunctions)
-
-## ばかり
-
-Means "only" or "nothing but", and can convey surprise or negative judgment depending on the context.
-Used with nouns and verbs.
-
-> [!info] Examples
-> この{国|くに}の{春|はる}は雨==ばかり==だ！
-> In this country, there's nothing but rain in spring.
-> 
-> うちの{子供|こども}はテレビ==ばかり==見てる。
-> My child does nothing but watching TV.
-
-## だけで
-
-Means "just by doing".
-Used with nouns and verbs.
-
-> [!info] Example
-> 会う==だけで=={幸|しあわ}せになる。
-> Just by meeting you, I get happy.
-
-## 又は
-
-{又|また}は can be used for two things:
-* choosing between two options ("or")
-* listing two options ("both")
-
-> [!info] Example
-> 日本語==又は==英語でしゃべれます。
-> I can speak both Japanese and English.
-
-## それでも
-
-Means "but still", "even so", "anyway".
-
-> [!info] Example
-> 雨が{降|ふ}っていた、==それでも==出かけていた。
-> It was raining, but I still went out.
-
-## のに
-
-### Even tough
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + な</span></p>
-</div>
-	<p class="right">+ のに</p>
-</div>
-
-The first meaning is "although", "even tough".
-
-> [!info] Example
-> 食べたばかり==なのに==、まだお{腹|なか}が{空|す}いた。
-> Even tough I just ate, I'm still hungry.
-
-### In order to
-
-Means "to do", "in order to".
-Used with a verb (dictionary).
-
-> [!info] Example
-> {勉強|べんきょう}する==のに=={図書館|としょかん}に行くつもりです。
-> In order to study, I plan to go to the library.
-
-## And: そして, それから, それに, それで
-
-See [[Listing#Connecting sentences]].

content/🔰 Grammar/Decision.md

@@ -1,23 +0,0 @@
-# Decision
-
-## ことになる
-
-Used for a decision that is made from an external factor. Means "it has been decided that".
-Used with verbs.
-
-> [!info] Example
-> {病気|びょうき}だから少し{仕事|しごと}を休む==ことになった==。
-> I had to take some time off work because I was sick.
-
-## ことにする
-
-Used for a decision that is made by oneself. Means "to decide on".
-Used with verbs.
-
-> [!info] Example
-> {吸|す}うを止める==ことにしました==。
-> I decided to stop smoking.
-
-## にする
-
-See [[Actions#To decide]].

content/🔰 Grammar/Description.md

@@ -1,119 +0,0 @@
-# Description
-
-## って・って言う・と言う
-
-Means "named", "called".
-* って and っていう: used after a noun.
-* という: used after a noun or a phrase.
-
-> [!info] Examples
-> ゴキブリ==って==虫しっているか。
-> Do you know the insect named cockroach?
-> 
-> スペイン語で、ゴキブリは「クカラチャ」==といいます==。
-> In Spanish, cockroaches are called "cucaracha".
-> 
-> {台風|たいふう}が来る==という==ニュース。
-> A news that a typhoon is coming.
-
-## と言ってもいい
-
-Means "you could say".
-
-> [!info] Examples
-> サッカーは{彼|かれ}の{得意|とくい}です。ほとんどサッカーのプロ==と言ってもいい==。
-
-## まま
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (ない)</span></p>
-	<p><span class="box">V (た)</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ まま</p>
-</div>
-
-Means that something doesn't change state, stays as it is.
-
-> [!info] Examples
-> {開|あ}けた==まま==。
-> To be left open.
-> 
-> {熱|あつ}い==まま==。
-> Still hot.
-> 
-> {昔|むかし}の==まま==。
-> As it always been.
-> 
-> その==まま==でいい。
-> It is fine as it is.
-
-## がする
-
-This means to experience a sense (except visual): to smell, to hear, to taste, etc, depending on the noun.
-
-> [!info] Example
-> いい{匂|にお}い==がする==。
-> It smells good.
-> 
-> 今日は{最悪|さいあく}日{気|き}==がする==。
-> I feel like today is the worst.
-
-## から作る・で作る
-
-Means "made from".
-
-> [!info] Example
-> チーズは{牛乳|ぎゅうにゅう}==から作る==。
-> Cheese is made from milk.
-
-## のが「好き・上手・下手」
-
-のが({好|すき}き・{上手|じょうず}・{下手|へた}) means "to (like/be good/be bad)" at an action.
-Used with a verb in dictionary form.
-
-> [!info] Example
-> テレビでサッカーを見る==のが好き==です。
-> I like watching soccer on the television.
->
-> 彼女は料理を作る==のが上手==と思います。
-> I think she is a good cook.
->
-> {絵|え}を{塗|ぬる}る==のが下手==です。
-> I'm not good at painting.
-
-## くらい・ぐらい
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (ない)</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ くらい・ぐらい</p>
-</div>
-
-Means "about" or "approximately" when talking about numbers or counter words. ぐらい is more common in conversations, but can change depending on the preceding word.
-
-> [!info] Example
-> {電車|でんしゃ}はどの==くらい==で{到着|とうちゃく}しますか。
-> About how much time will the train take to arrive?
-> 
-> {医者|いしゃ}に１時間==ぐらい==を{待|ま}ってました。
-> I waited approximately an hour for the doctor.
-
-Also used to compare things as being similar.
-
-> [!info] Example
-> {友達|ともだち}と{試験|しけん}の{結果|けっか}は{同|おな}じ==ぐらい==です。
-> My friend and I have about the same results at the test.
-
-Also means "to the extent of".
-
-> [!info] Example
-> 食べなくて{寝|ね}たい==ぐらい=={疲|つか}れています。
-> I'm tired to the extent of not eating and going to sleep.

content/🔰 Grammar/Experience.md

@@ -1,9 +0,0 @@
-# Experience
-
-## たことがある
-
-Used with past verbs to talk about things experienced before.
-
-> [!info] Example
-> 日本に行==ったことがあるですか==。
-> Have you ever been to Japan?

content/🔰 Grammar/Give - Receive - Lend - Borrow.md

@@ -1,89 +0,0 @@
-# Give and receive; lend and borrow
-
-## Give and receive
-
-### あげる
-
-<div class="usage">
-	<p class="r">Giver が Receiver に Object を + </p>
-<div class="">
-	<p><span class="box">あげる</span></p>
-</div>
-</div>
-
-Used when you give an object to someone.
-
-> [!info] Example
-> {友達|とも|だち}に本を==あげる==。
-> I give a book to my friend.
-
-### くれる
-
-<div class="usage">
-	<p class="r">Giver が Receiver に Object を + </p>
-<div class="">
-	<p><span class="box">くれる</span></p>
-</div>
-</div>
-
-Used when someone gives an object to you.
-
-> [!info] Example
-> {友達|とも|だち}が本を==くれる==。
-> My friend gives me a book.
-
-### もらう
-
-<div class="usage">
-	<p class="r">Receiver が Giver 「に・から」 Object を + </p>
-<div class="">
-	<p><span class="box">もらう</span></p>
-</div>
-</div>
-
-Used when you receive an object from someone.
-
-> [!info] Example
-> {友達|とも|だち}に本を==もらう==。
-> I get a book from my friend.
-
-### When to use?
-
-#### Giving
-
-There's a nuance between the two terms depending on who you are close to.
-The general rule is that you:
-* use ==あげる== if you, your friends or family give something to others (closer to giver's side).
-* use ==くれる== if you, your friends or family are receiving things from others (closer to receiver's side).
-
-In both cases, the topic is the giver.
-
-#### Receiving
-
-There's only one word: ==もらう==, and it doesn't matter who you are close to.
-
-In this case, the topic is the receiver.
-
-## Lend and borrow
-
-### 貸す
-
-{貸|か}す means to lend.
-
-> [!info] Examples
-> 傘を==貸しました==。
-> I lent my umbrella.
-> 
-> 傘を==貸して==くれませんか？
-> Could you do me a favor of lending me your umbrella?
-> 
-> トイレ==貸りて==もいい。
-> Could I use your toilets?
-
-### 借りる
-
-{借|か}りる means to borrow.
-
-> [!info] Example
-> 傘を==借りました==。
-> I borrowed the umbrella.

content/🔰 Grammar/Listing.md

@@ -1,138 +0,0 @@
-# Listing
-
-## Connecting sentences
-
-### そして
-
-This conjunction means "and". It implies a cause-effect relationship between the two sentences. There's an interconnection, where the order of the actions cannot be changed.
-
-> [!info] Examples
-> バスケットボールをした。==そして==水を{飲|の}んだ。
-> I played basketball. Then, I drank water.
-
-### それから
-
-This conjunction means "and" or "after that". It implies a chronological order to the events. Since there's no interconnection, the order of actions could be changed.
-
-> [!info] Examples
-> スーパーに行きました。==それから=={弁当|べんとう}を食べました。
-> I went to the supermarket. After that, I ate my bento.
-
-### それに
-
-This conjunction means "and", "besides" or "in addition". Implies a new information in relation to the precedent one. It is not used to add a negative information to a positive one, and vice-versa.
-
-> [!info] Examples
-> 昨日、{病気|びょうき}になった。==それに==パソコンも{壊|こわ}れた。
-> I got sick yesterday. Beside, my computer broke.
-
-### それで
-
-Means "because of that", "therefore". Substitutes the first sentence happening before by それ, highlighting information from it.
-
-> [!info] Examples
-> {子供|こども}のころ、毎日{電車|でんしゃ}で{通|かよ}うていた。==それで=={電車|でんしゃ}{運転手|うんてんしゅ}になりたかった。
-> When I was a child, I took the train to school every day. Because of that, I wanted to be a train driver.
-
-## Exhaustive listing
-
-### と
-
-This particles means "and" or "with". Used for a list that is exhaustive. Connects sentences.
-
-> [!info] Examples
-> 犬==と=={住|す}んでいます。
-> I live with my dog.
-> 
-> フランス語==と==スペイン語を習っています。
-> I am learning French and Spanish.
-
-### て connecting
-
-Used for a list that is exhaustive. Connects verbs.
-See [[TeF (1) - basics#て sequence]].
-
-## Unexhaustive listing
-
-### や
-
-Used for a list that is unexhaustive. Translates to "among other things". Formal.
-Used only with nouns. Cannot be repeated!
-
-> [!info] Example
-> フランス==や==スペインに{旅行|りょこう}しました。
-> I travelled to France and Spain (among others).
-
-### など
-
-Means "things as". Can be used with や for a meaning like "etc".
-Used with nouns. Cannot be repeated!
-
-> [!info] Example
-> お金がないのでカフェ**や**レストラン==など=={払|はら}えない。
-> I can't pay things like cafes or restaurant (etc.) because I have no money.
-
-### とか～とか
-
-Used for a list that is unexhaustive. Translates to "among other things". More casual than や or たり～たり. Ending a sentence with とか can soften the meaning. Can also be used to quote someone.
-Only used with verbs and nouns. Can be repeated.
-
-> [!info] Examples
-> {果物|くだもの}はバナナ==とか==リンゴ==とか==が好きです。
-> I like fruits like bananas and apples.
-> 
-> 明日{野球|やきゅう}==とか==しようか。
-> Do you want to play baseball (or something) tomorrow?
-> 
-> もう{諦|あきら}めよう==とか==言わないで。
-> Don't say (things like) we should already give up.
-
-### たり～たり
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V-た</span></p>
-	<p><span class="box">い-Adj <strike>い</strike> かった</span></p>
-	<p><span class="box">な-Adj + だった</span></p>
-	<p><span class="box">N + だった</span></p>
-</div>
-	<p class="right">+ り</p>
-</div>
-
-This is used to list things that are related, in an unexhaustive way. Translates to "do things such as".
-Usually used to talk about things like hobbies, explaining liked things, activities done, etc.
-
-> [!info] Example
-> {週末|しゅうまつ}に{泳|およ}い==だり==、{散歩|さんぽ}し==たり==、{買|か}い{物|もの}し==たり==します。
-> On the weekends, I do things like swimming, walking and shopping.
-
-### し
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual)</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + だ</span></p>
-	<p><span class="box">N + だ</span></p>
-</div>
-	<p class="right">+ し</p>
-</div>
-
-Used for a list that is unexhaustive, going in the same direction: for example reasons, causes, qualities, etc.
-It can be used to emphasize something when used at the end of a sentence.
-
-> [!info] Examples
-> この電車は{速|はや}い==し==デザインもかっこいい。
-> This train is fast and has a cool design.
-> 
-> 言ってない==し==！
-> I never said that!
-
-## Summing up
-
-🛠 To do: finish.
-
-* ==や== is formal and cannot be repeated (nouns only). Can be completed by ==など==.
-* ==とか== is casual and can be repeated.
-* ==たり==
-* ==し==

content/🔰 Grammar/Must (not).md

@@ -1,98 +0,0 @@
-# Must & must Not
-
-## が必要・必要がある
-
-Means "needed" or "necessary".
-が{必要|ひつよう} is used mainly with nouns (can be used with verbs by appending こと before).
-{必要|ひつよう}がある is used with verbs.
-
-> [!info] Example
-> {今時|いまどき}、{携帯電話|けいたいでんわ}==が必要です==。
-> Nowadays, a cell phone is necessary.
-> 
-> 今日はパン{屋|や}に行く==必要がない==。
-> No need to go to the bakery today.
-
-## Must
-
-### なくちゃ・なきゃ
-
-Only used on casual spoken conversations.
-This form is used with the negative form of a verb (ない), and adding なくちゃ and optionally one of the following ending: だめ, いけない, いけません, ならない, なりません.
-
-なくちゃ is the shortened form of なくては.
-なきゃ is the shortened form of なければ.
-
-> [!info] Example
-> {歯|は}を{磨|みが}か==なくちゃいけない==。
-> I must brush my teeth.
-
-### なくては「いけない・ならない」
-
-Also formed with the negative form of a verb.
-
-> [!info] Example
-> 今{遅|おそ}いね。{寝|ね}に行か==なくてはいけない==。
-> It's late now. I have to go to sleep.
-
-### なければ「いけない・ならない」
-
-Also formed with the negative form of a verb.
-
-> [!info] Example
-> {事務所|じむしょ}では{静|しず}かにし==なければならない==。
-> You have to be quiet in the office.
-
-### ないといけない
-
-Also formed with the negative form of a verb.
-In casual contexts, can be shortened as ないと.
-
-> [!info] Example
-> 今日は{勉強|べんきょう}し==ないといけない==。
-> I have to study today.
-
-### Comparing いけない and ならない
-
-* ==いけない== is the standardly used form. It implies a subjective view, that it would be better to do something, to avoid negative consequences (eg: brushing one's teeth, eating well, etc).
-* ==ならない== is usually more formal or in written form. It implies a is more objective view, something that has to be done because there's no other way (eg: respecting the law, paying taxes, etc).
-
-### Comparing なくては, なければ and ないと
-
-なくては and なければ are generally interchangeable in speech. However:
-* ==なくては== is generally used when there is _no penalty_ for not complying.
-* ==なければ== is generally used when there _is a penalty_ for not complying.
-* ==ないと== is lighter and does not imply that there can or cannot be penalty. Its construction is based on the [[Conditional#と]] particle, and should be based on knowledge or experience.
-
-## Must not
-
-#### 「ちゃ・じゃ」「だめ・いけない・いけません」
-
-Only used on casual spoken conversations. いけません is a bit more formal.
-This form is used with a V-て, depending on the ending:
-* with て, ちゃ is used.
-* with で, じゃ is used.
-
-> [!info] Examples
-> その{花|はな}を食べ==ちゃだめ==。
-> Don't eat those flowers.
-> 
-> {花瓶|か|びん}の水を{飲|の}ん==じゃいけない==。
-> Don't drink the water of the flower vase.
-
-### てはいけない
-
-Used in a more formal or written manner. Used with a V-て.
-
-> [!info] Example
-> {鉄道|てつ|どう}に{歩|ある}い==てはいけません==。
-> Do not walk on the railroad.
-
-### なくてもいい
-
-Means "don't have to". Used with a verb in the negative form (ない), appending なくてもいい.
-Can also be used as なくていい.
-
-> [!info] Example
-> 今日はレストランで{手伝|て|つ}わ==なくてもいい==。
-> You don't have to help out at the restaurant today (it's okay if you don't help at the restaurant today).

content/🔰 Grammar/Observation - Description.md

@@ -1,253 +0,0 @@
-# Observation & description
-
-## がる・がっている
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">い-Adj <strike>い</strike></span></p>
-	<p><span class="box">な-Adj</span></p>
-</div>
-	<p class="right">+ がる ・ がっている</p>
-</div>
-
-This transforms adjective into verbs, and means "to show signs of", "to appear like".
-Can be conjugated: がっている means to currently show signs, がていた means to have shown signs.
-
-> [!info] Example
-> {彼女|かのじょ}は虫を{怖|ごわ}==がる==。
-> She seems afraid of insects.
-
-## がり
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">い-Adj <strike>い</strike></span></p>
-	<p><span class="box">な-Adj</span></p>
-</div>
-	<p class="right">+ がり</p>
-</div>
-
-Expresses a personality trait (tendency to, sensitivity towards).
-
-> [!info] Example
-> {彼|かれ}はを{怖|ごわ}==がり==。
-> He has a tendency of being scared.
-
-## Looks like
-
-### よう
-
-Means that it looks like. Used from direct knowledge or experience, with a high degree of confidence. It is a more polite form of みたい.
-
-#### ようだ
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual)</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ ようだ</p>
-</div>
-
-Means that it looks like, appears like, seems like.
-
-> [!info] Example
-> {子供|こども}が{嬉|うれ}しい==ようだ==。
-> The kids look happy (= I can see them laughing and smiling).
-
-#### ように・ような
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual)</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ [ように + V] ・ [ような + N]</p>
-</div>
-
-Expresses "in the manner of".
-
-> [!info] Examples
-> {新幹線|しんかんせん}の==ような=={速度|そく|ど}。
-> Speed like a Shinkansen.
-> 
-> アヒルの==ように==食べる。
-> To eat like a duck.
-
-### みたい
-
-みたい means similar to, like. Used for direct observation, with a high degree of certainty in consequence.
-It is a less polite form of ようだ.
-
-#### みたいだ
-
-The basic form, used with all forms of words.
-
-> [!info] Example
-> 今日は暑いですね。夏==みたいだ==な。
-> It's hot today, isn't it. It looks like it's summer.
-
-#### みたいに
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual)</span></p>
-	<p><span class="box">N</span></p>
-</div>
-	<p class="right">+ みたいに + V / Adj</p>
-</div>
-
-The adverbial form.
-
-> [!info] Example
-> 犬==みたいに==食べた。
-> I ate like a dog.
-
-#### みたいな
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual)</span></p>
-	<p><span class="box">N</span></p>
-</div>
-	<p class="right">+ みたいな + N</p>
-</div>
-
-Similar to the precedent form, but when using with nouns.
-
-> [!info] Example
-> {故郷|ふる|さと}==みたいな==町だ。
-> A city like my hometown.
-
-### っぽい
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V <strike>ます</strike></span></p>
-	<p><span class="box">い-Adj <strike>い</strike></span></p>
-	<p><span class="box">N</span></p>
-</div>
-	<p class="right">+ っぽい</p>
-</div>
-
-This has the meaning of like, easy to, _-ish_. Makes a direct comparison with certainty, from the point of view of the person saying it. Close to an even more casual meaning of みたい.
-
-> [!info] Examples
-> {子供|こ|ども}==っぽい==。
-> Childish.
-> 
-> {忘|わす}れ==っぽい==。
-> Easy to forget.
-
-### らしい
-
-Expresses an information based on hearsay, or based on the situation, or ressemblance. This is always used bases on a source that is unknown or ambiguous. It can be similar to a guess.
-Also used for something typical.
-
-> [!info] Examples
-> 男==らしい==。
-> Typical of a man (befitting of a man).
-> 
-> 今日は{君|きみ}==らしくない==。
-> You aren't yourself today.
-
-### そう
-
-#### そうだ
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual)</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + だ</span></p>
-	<p><span class="box">N + だ</span></p>
-</div>
-	<p class="right">+ そうだ</p>
-</div>
-
-Means "I heard that".
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V <strike>ます</strike></span></p>
-	<p><span class="box">い-Adj <strike>い</strike></span></p>
-	<p><span class="box">な-Adj + だ</span></p>
-</div>
-	<p class="right">+ そうだ</p>
-</div>
-
-Means that it looks like.
-
-> [!info] Examples
-> テストは{難|むず}しい==だそうだ==。
-> The exam is said to be difficult.
-> 
-> おいし==そうだ==。
-> lt looks like it is delicious.
-
-#### そうに・そうな
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V <strike>ます</strike></span></p>
-	<p><span class="box">い-Adj <strike>い</strike></span></p>
-	<p><span class="box">な-Adj + だ</span></p>
-</div>
-	<p class="right">+ 「そうに・そうな」 + N・V</p>
-</div>
-
-Also means that it looks like, but connecting to nouns and verbs.
-
-> [!info] Example
-> 面白==そうに==人です。
-> He seems like an interesting person.
-
-### Summing it up
-
-🛠 To do: check validity.
-
-* ==ようだ== is a formal way to say that it looks like, usually from direct observation.
-* ==みたい== is a less formal way, used in a casual conversation.
-* ==っぽい== is even more casual. A girl trying to be masculine would be 男っぽい.
-* ==らしい== is usually used when something is typical or expected. The same girl wouldn't be either 女らしい or 男っぽい because it's not what is expected from her.
-* ==そうだ== is used for something that is hearsay or not directly observation, more as a guess.
-
-## に見える
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (て)</span></p>
-	<p><span class="box">V (casual) + ように</span></p>
-	<p><span class="box">い-Adj + <strike>い</strike>く</span></p>
-	<p><span class="box">な-Adj + に</span></p>
-	<p><span class="box">N + (のよう) + に</span></p>
-</div>
-	<p class="right">+ 見える</p>
-</div>
-
-This is used (unlike other forms that can apply to abstract similarities) exclusively for visual resemblance.
-
-> [!info] Example
-> {彼女|かのじょ}はフランス人==に見える==。
-> She looks like she is French.
-
-## I heard that...
-
-### と言われている
-
-Used for something you heard by someone identifiable: for example, you were told by someone.
-For nouns, だ is placed before.
-
-> [!info] Example
-> このレストランのカレーはおいしいだ==と言われています==。
-> The curry of this restaurant is good (someone told me).
-
-### と聞いた
-
-Used when you heard something, but not from someone specifically identifiable: general knowledge, a rumour, etc.
-
-> [!info] Example
-> 彼はバカ==と聞いた==。
-> They say he's an idiot (I've heard that he's an idiot).

content/🔰 Grammar/Opposition.md

@@ -1,39 +0,0 @@
-# Opposition
-
-## が
-
-Between two sentences, it has the meaning of "but".
-
-> [!info] Example
-> この{建物|たてもの}は大きいです==が==、トイレは{一|ひと}つだけあります。
-> This building is huge but has only one toilet.
-
-## でも
-
-This is the basic way to say "but".
-
-> [!info] Example
-> コンビニに行きました。==でも==、何も買わなかった。
-> I went to the convenience store. But I didn't buy anything.
-
-## しかし
-
-This is similar to でも, meaning "however", but usually more formal and most commonly found in written form.
-
-> [!info] Example
-> {戦争|せん|そう}は{悪|わる}いこと。==しかし==、{人類|じん|るい}はいつも{戦|たたか}っています
-> War is bad. However, humanity is always fighting.
-
-## けど・けれども
-
-けれども is more formal than けど. Contrary to でも (which is more stand-alone), this links two clauses. The second clause can also be implicit and not said.
-
-> [!info] Example
-> {外|そと}は{暑|あつ}い==けど==行きたい。
-> It's hot outside but I'd still like to go.
-
-It can also be used to soften your assertion.
-
-> [!info] Example
-> {明日|あした}に行きたい==けど==。
-> I'd like to go tomorrow... (but I don't want to cause any inconvenience).

content/🔰 Grammar/Planning - Wishing.md

@@ -1,35 +0,0 @@
-# Planning & wishing
-
-## ようと思う
-
-ようと{思|おも}う means "thinking of doing".
-Used with a verb in the volitional form (よう).
-
-> [!info] Example
-> レストランへ行こ==うと思います==。
-> I'm thinking of going to the restaurant.
-
-## つもり
-
-Means "intend to".
-
-> [!info] Example
-> 明日ゲームセンターに行く==つもり==はない。
-> I don't plan to go to the arcade tomorrow.
-
-## よてい
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (dictionary)</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ 予定だ</p>
-</div>
-
-It means "plan to".
-This form is stronger than つもり. For a same sentence, the nuance could be a strong intention for つもり, while with よてい the plan has already been booked.
-
-> [!info] Example
-> 来年日本へ行く==予定==です。
-> I'm planning to go to Japan next year (I have my tickets).

content/🔰 Grammar/Possibility - Obligation.md

@@ -1,81 +0,0 @@
-# Possibility and obligation
-
-## でも
-
-Used to list one or more possible options.
-
-> [!info] Example
-> ジュース==でも==お茶==でも==飲もうか。
-> Shall we drink something like a juice or tea?
-
-## かもしれない
-
-Express a possibility, like "perhaps".
-By order of politeness: かもしれません > かもしれない > かも.
-
-> [!info] Example
-> 今日も来る==かもしれない==。
-> He might come today too.
-
-## かどうか
-
-Means "whether or not". 
-
-> [!info] Example
-> 行きたい==かどうか=={分|わ}からない。
-> I'm not sure if I want to go or not.
-
-## はずだ・はずがない
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ はずだ ・ はずがない</p>
-</div>
-
-はずだ means "it must/should be", while はずがない means "it cannot be".
-
-> [!info] Examples
-> {彼|かれ}は今日来る==はずだ==。
-> He should be coming today.
-> 
-> そんあ==はずがありません==。
-> This cannot be true.
-
-## ぜひ
-
-Means certainly, definitely. Expresses a wish.
-
-> [!info] Example
-> この{映画|えい|が}==ぜひ==見ます。
-> I'll watch this movie for sure.
-
-## きっと
-
-Means surely, almost certainly. Express an expectation.
-
-> [!info] Example
-> ==きっと==雨でしょう。
-> It will surely rain.
-
-## 必ず
-
-{必|かなら}ず means certainly, definitely. Expresses an obligation.
-
-> [!info] Example
-> 明日の{授業|じゅ|ぎょう}==必ず==来てください。
-> Please be sure to attend tomorrow's class.
-
-## ことができる
-
-Means "can", "able to".
-It has the same meaning as the potential form (see Conjugation [[Basics]]).
-食べる => 食べられる = 食べることができる.
-
-> [!info] Example
-> {英語|えいご}を{話|はな}す==ことが出来ない==。
-> I cannot speak English.

content/🔰 Grammar/Question.md

@@ -1,90 +0,0 @@
-# Question
-
-## か
-
-At the end of a sentence, this particle asks a question, like a question mark.
-
-> [!info] Example
-> {猫|ねこ}が好きです==か==。
-> Do you like cats?
-
-It can also be used when there is uncertainty between two or more choices. It can be used once or multiple times.
-
-> [!info] Example
-> 犬==か==猫==か==、どちら{選|えら}んでますかな。
-> Which should I chose, a dog or a cat?
-> 
-> 雨==か=={分|わ}かりません。
-> I don't know if it will rain.
-
-## Probably - right - isn't it?
-
-### でしょう
-
-Means "probably", "right?". The polite version of だろう.
-
-> [!info] Example
-> この{服|}はきれい==でしょう==。
-> These clothes are beautiful, aren't they? (It's probably what you also think?)
-
-### だろう
-
-Means "probably", "right?". The casual version of でしょう.
-
-> [!info] Example
-> 今日また雨==だろう==。
-> It will probably rain again.
-
-### ではないか
-
-Means "isn't it?". The polite version of じゃないか.
-
-> [!info] Example
-> 今の{揺|ゆ}れは{地震|じ|しん}==ではないか==。
-> That shaking is an earthquake, isn't it?
-
-### じゃないか
-
-Means "isn't it?". The casual version of ではないか.
-
-> [!info] Example
-> アイスクリームを食べよう==じゃないか==。
-> Let's have some ice cream, shall we?
-
-### ね
-
-This particle when added to the end of a sentence meaning "right?".
-
-> [!info] Example
-> 今日は{寒|さむ}いです==ね==。
-> It's cold today, right?
-
-### Summing up
-
-* ==でしょう==・==だろう== expresses a probability or an assumption.
-* ==ではないか==・==じゃないか== invites or suggests an action.
-* ==ね== asks an agreement or a confirmation.
-
-## かな・かしら
-
-Means "I wonder", "should I?". かな is a neutral form, while かしら sounds feminine.
-
-> [!info] Example
-> この{帽子|ぼうし}を{被|かぶ}ろう==かな==。
-
-## かい
-
-Using this particle, the sentences becomes a yes/no question. Very casual, masculine connotation.
-
-> [!info] Example
-> 来るの==かい==。
-> Are you coming?
-
-## どうやって
-
-Means "how", "in what way".
-
-> [!info] Example
-> これを==どうやって==作れましたか。
-> How did you make this?
-

content/🔰 Grammar/Reason.md

@@ -1,56 +0,0 @@
-# Reason
-
-## ので
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + だ</span></p>
-</div>
-	<p class="right">+ ので</p>
-</div>
-
-Used after a reason, to explain the consequence. Means "because of", "since".
-It is more objective than から: it expresses a situation that exists, and that is outside of one's control. For this reason, it can also be perceived as more polite.
-
-> [!info] Example
-> 雨な==ので==傘を持ってきてください。
-> Since it is raining, please bring an umbrella.
-
-## から
-
-See [[🔰 Particles (2)#Because]].
-It is more subjective than ので: it expresses more personal needs/actions/opinions.
-
-## んです・のです
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + だ</span></p>
-</div>
-	<p class="right">+ んだ・んです・のだ・のです</p>
-</div>
-
-It is used to explain or put emphasis on something.
-のだ・のです is a bit more formal than んだ・んです.
-It is only used with nouns when asking questions.
-
-> [!info] Example
-> {良|よ}い{仕事|しごと}な==のです==か。
-> Is it a good job?
-> 
-> もう言った==んだ==よ！
-> I've already told you!
-
-## のは・のが
-
-See [[Transformation#のは・のが sentence as noun]].
-
-## のに
-
-See [[Connectors#のに]].

content/🔰 Grammar/Request.md

@@ -1,55 +0,0 @@
-# Request
-
-## てください
-
-It is a polite request that is translated as "please do". See Conjugation [[Basics]] ("command").
-In casual speech, can be shortened to て.
-
-> [!info] Example
-> {消|けし}しゴムを{貸|か}し==て==。
-> Lend me your eraser.
-
-## てもいい
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V-て</span></p>
-	<p><span class="box">い-Adj <strike>い</strike> くて</span></p>
-	<p><span class="box">な-Adj + で</span></p>
-	<p><span class="box">N + で</span></p>
-</div>
-	<p class="right">+ もいい</p>
-</div>
-
-Means "is it alright if?", "may I?".
-
-> [!info] Example
-> ここに{座|すわ}==てもいい==ですか。
-> May I sit here?
-
-## ないでください
-
-Means "please don't". It is a polite request. Removing the ください makes it more casual.
-Formed by a verb in the negative form (ない) with the で particle.
-
-> [!info] Example
-> {冷蔵庫|れいぞうこ}のデザートは食べ==ないでください==。
-> Please do not eat the dessert from the fridge.
-
-## なさい
-
-This form is used when commanding an action.
-It is used with verbs by removing the ます and adding なさい. In casual conversation, it can be shortened to な.
-
-> [!info] Example
-> {質問|しつ|もん}を{答|こた}え==なさい==。
-> Answer the question.
-
-## ように言う
-
-It means "to tell", "to request", "to order".
-It is form by added ように{言|い}う to a verb. The verb {頼|たの}む can be used for requests, while {命|めい}じる can be used for order. The verb {言|い}う can tell the three meanings depending on the tone.
-
-> [!info] Example
-> {子供|こども}にお{菓子|か|し}を食べない==ように言った==。
-> I told the kids to not eat candies.

content/🔰 Grammar/Time.md

@@ -1,233 +0,0 @@
-# Time
-
-## とき
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual)</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ とき</p>
-</div>
-
-Means "time". When used like this, means "at the time of".
-
-> [!info] Example
-> 行った==とき==、{誰|だれ}もいなかった。
-> When I went, no one was there.
-
-## ところ
-
-Means "just about to". Used when describing what we're about to do.
-Used by combining to a verb.
-
-> [!info] Example
-> 今ご{飯|はん}を作る==ところ==です。
-> I'm about to make dinner.
-
-## ことがある
-
-Means "there are time when".
-Used by combining to a verb.
-
-> [!info] Example
-> {時々|とき|どき}パリへ行く==ことがある==。
-> I sometimes go to Paris.
-
-## ながら
-
-<div class="usage">
-<div class="">
-	<p><span class="box">V-<strike>ます</strike></span></p>
-</div>
-	<p class="r"> + ながら + ...</p>
-</div>
-
-Means "while", "simultaneously".
-
-> [!info] Example
-> {歩|ある}き==ながら=={電話|でん|わ}を見ています。
-> While walking, I'm looking at my phone.
-
-## 間
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (dictionary)</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ 間</p>
-</div>
-
-{間|あいだ} means "while" or "during". Used to express something that is done for the whole period of time.
-
-> [!info] Example
-> 電車に{乗|の}っている==間==、ゲームをしてた。
-> While I was on the train, I was playing a game.
-
-Can also be used to talk about a distance between two physical places or the time between two things.
-
-> [!info] Example
-> １時から９じまでの==間==、{寝|ね}ます。
-> I sleep between 1AM and 9AM.
-
-## 間に
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual, non-past)</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ 間に</p>
-</div>
-
-A first meaning is similar to {間|あいだ} (while), but with intentionality.
-
-> [!info] Example
-> 電車に{乗|の}った==間に==、本を読みました。
-> While I was on the train, I read a book.
-
-A second meaning is a statement of something that happened during a time period, independently of your actions.
-Contrary to 間, it doesn't include the whole time period. So 間に means that at a point during the time period, something happened.
-
-> [!info] Example
-> {夜|よる}の==間に==、{隣|となり}の木が{落|お}ちていた。
-> During the night, the tree next door fell.
-
-# から～まで
-
-See から: [[🔰 Particles (2)#From, since]].
-See まで: [[🔰 Particles (2)#まで]].
-See から～まで: [[🔰 Particles (2)#から～まで]].
-
-## 前に
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (dictionary)</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ 前に</p>
-</div>
-
-{前|まえ}に means before (time) or in front of (place).
-
-> [!info] Examples
-> {寝|ねる}る==前に==、レストランに行こうと思います。
-> I think I'll go to the restaurant before sleeping.
-> 
-> レストランの==前に=={自転車|じ|てん|しゃ}があります。
-> There are bikes in front of the restaurant.
-
-## 後で
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (た)</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ 後で</p>
-</div>
-
-{後|あと}で means after or later.
-⚠ Only works with the past form of verbs!
-
-> [!info] Example
-> 食べた==後で==、寝ます。
-> After eating, I'll go to sleep.
-
-## さっき
-
-Means that something happened recently, either just now, or a little while ago.
-
-> [!info] Example
-> ==さっき==家に出てきた。
-> I just left home.
-
-## たところ
-
-Combined with a verb in the past tense, it express that something just occurred (something just ended, just started, etc).
-
-> [!info] Example
-> 今食べた==ところ==だ。
-> I just finished to eat right now.
-
-## ているところ
-
-See [[TeF (2) - manner of doing#ているところ]].
-
-## たばかり
-
-Combined with a verb in the past tense, it express that something just occurred (something just ended, just started, etc). It is more subjective than ところ. It doesn't have to be something that literally just happened, but something that feels like it just happened. 
-
-> [!info] Example
-> 今食べた==ばかり==だ。
-> I just finished to eat right now.
-
-When comparing the two examples, the meaning is different depending on the context. Imagine a friend asking you to go eat with him. When using ところ, it means you just finished your meal this instant. When using ばかり, it means that it feels too soon to eat again just yet from your point of view, independently of how much time has really passed.
-
-## 急に
-
-{急|きゅう}に means that something happened unexpectedly or quickly.
-
-> [!info] Example
-> ==急に==電車が{現|あらわ}れた。
-> A train suddenly appeared.
-
-## やっと
-
-Means that something happened at last. More rarely means "barely".
-
-> [!info] Example
-> ==やっと=={論文|ろん|ぶん}を書き{終|お}わった。
-> I finally finished writing my thesis.
- 
-## までに
-
-This indicates a time limit for the action, similar to "by".
-
-> [!info] Example
-> {来週|らい|しゅう}==までに=={終|お}わってください。
-> Please finish by next week.
-
-## おきに
-
-This is used for repeated intervals, after a noun indicating something measurable.
-
-> [!info] Example
-> この電車は４分==おきに=={出発|しゅ|っぱつ}します。
-> This train leaves every four minutes.
-
-## ころ・ごろ
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">N (time)</span></p>
-</div>
-	<p class="right">+ ごろ</p>
-</div>
-
-Means "around" or "about".
-
-> [!info] Example
-> 午後８時==ごろ==来てください。
-> Please come around 8PM.
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual)</span></p>
-	<p><span class="box">い/な-Adj</span></p>
-	<p><span class="box">N + の</span></p>
-</div>
-	<p class="right">+ ころ</p>
-</div>
-
-Means "when".
-
-> [!info] Example
-> 子供の==ころ==、毎日{公園|こうえん}で{遊|あそ}んだ。
-> When I was a kid, I played every day at the park.

content/🔰 Grammar/Transformation.md

@@ -1,91 +0,0 @@
-# Transformation
-
-## こと: verb as noun
-
-This allows to transform a verb into a noun (verb nominalizer).
-V+こと => 食べること. The verbs are never conjugated.
-
-> [!info] Example
-> {音楽|おん|がく}を聞く==こと==が好きです。
-> I like to listen to music (listening to music is something I like).
-
-## ~さ: adjective as noun
-
-This allows to transform an adjective into a noun (adjective nominalizer).
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">な-Adj</span></p>
-	<p><span class="box">い-Adj <strike>い</strike></span></p>
-</div>
-	<p class="right">+ さ</p>
-</div>
-
-> [!info] Example
-> やさしい。
-> Kind.
-> 
-> やさし==さ==。
-> Kindness.
-
-## ということ: phrase as noun
-
-This allows to transform a phrase into a noun.
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V (casual)</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + だ</span></p>
-	<p><span class="box">N + だ</span></p>
-</div>
-	<p class="right">+ ということ</p>
-</div>
-
-> [!info] Example
-> 毎日サッカーをする==ということ==は{大変|たい|へん}です。
-> It is hard to play soccer every day.
-
-## のは・のが: sentence as noun
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + な</span></p>
-	<p><span class="box">N + だ</span></p>
-</div>
-	<p class="right">+ のは・のが</p>
-</div>
-
-Transforms a sentence into a noun.
-Also means "the reason for A is B", "doing A is B".
-
-> [!info] Example
-> {勉強|べんきょう}する==のは==つまらないです。
-> Studying is boring.
-> 
-> このレストランで{一番|いち|ばん}{人気|にん|き}がある==のは=={寿司|すし}です。
-> The most popular dish in the restaurant is sushi.
-
-## くする: い-adjectives as adverbs
-
-Replacing the い in a い-Adj by くする transforms it into an adverb.
-大きい (big) => 大きくする (make big).
-
-> [!info] Example
-> エアコンを{点|つ}けると{空気|くう|き}が{寒|さむ}==くなる==。
-> When turning on the AC, the air becomes cold.
-
-## にする: な-adjectives as adverbs
-
-Appending にする to a な-Adj transforms it into an adverb.
-{静|しず}かな (quiet) => 静かにする (make quiet).
-
-> [!info] Example
-> {部屋|へや}をきれい==にして==ください。
-> Please clean the room (make the room cleaner).
-
-## がる・がっている: adjectives as verbs
-
-See [[Observation - Description#がる・がっている]].

content/🔰 Grammar/Wanting.md

@@ -1,60 +0,0 @@
-# Wanting
-
-## たい
-
-<div class="usage">
-<div class="">
-	<p><span class="box">V-<strike>ます</strike></span></p>
-</div>
-	<p class="r">+ たい</p>
-</div>
-
-This form is used for yourself when you want to do something. It can be conjugated: たい, たくない, たかった.
-
-> [!info] Examples
-> おにぎりを食べ==たい==。
-> I want to eat an onigiri.
-
-## たがる
-
-<div class="usage">
-<div class="">
-	<p><span class="box">V-<strike>ます</strike></span></p>
-</div>
-	<p class="r">+ たがる</p>
-</div>
-
-This form is used to express that someone else wants to do something.
-See also [[Observation - Description#がる・がっている]].
-
-> [!info] Examples
-> {彼女|かのじょ}は毎日{練習|れんしゅう}し==たがった==。
-> She wanted to practice everyday.
-
-## がほしい
-
-This form is used when someone wants something. Can be used for yourself.
-Used with a noun.
-
-> [!info] Examples
-> どんなゲーム==が欲しい==ですか。
-> What game would you like to have?
->
-> 新しいRPG==がほしい==。
-> I want the new RPG.
-
-## てほしい
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V-て</span></p>
-	<p><span class="box">V-ないで</span></p>
-</div>
-	<p class="right">+ ほしい</p>
-</div>
-
-This form is used when you want someone to do something.
-
-> [!info] Examples
-> 私が作った料理を食べ==てほしい==。
-> I want you to eat the food I prepared.

content/🔰 Grammar/Without.md

@@ -1,9 +0,0 @@
-# Without
-
-## ないで
-
-Means "without doing". Formed with a verb in the negative tense (ない).
-
-> [!info] Example
-> {勉強|べんきょう}し==ないで=={卒業|そつぎょう}した。
-> I graduated without studying.

content/🔰 Grammar/🔰 Particles (1).md

@@ -1,164 +0,0 @@
-# Particles (1)
-
-## は
-
-The は particle indicates the topic of a sentence. Usually translated by "as for".
-
-> [!info] Example
-> 私==は==フランス人です。
-> I am French (As for me, I am French).
-
-When a sentence is negative, は is usually used instead of が and を.
-
-> [!info] Example
-> 肉==は==食べません。
-> I don't eat meat.
-
-## が
-
-The が particle indicates the subject of a sentence.
-
-> [!info] Example
-> 電車==が==好きです。
-> I like trains.
-
-It is also used for making a contrast.
-
-> [!info] Example
-> 電車は好きです==が==、バスは好きじゃない。
-> I like trains, but I don't like buses.
-
-In a noun modifying clause, は becomes が.
-
-> [!info] Example
-> {彼|かれ}はラメんを{作|つく}。
-> He made ramen.
-> 
-> {彼|かれ}==が=={作|つく}ったラメんはおいしいです。
-> The ramen he made is delicious.
-
-## Difference between は and が
-
-Usually, they can be used in the same sentence, but have a nuanced meaning based on the context.
-
-> [!info] Examples
-> 私==は==フランス人です。
-> 私==が==フランス人です。
-> I am French.
-
-Both sentences mean the same thing. But:
-* In the first sentence with は, what is highlighted is that the speaker is French.
-* In the second sentence with が, what is highlighted is that the French person is the speaker.
-The first sentence would most likely be the answer to "where are you from?", while the second sentence would be the answer to "who is French?". が highlights the information where the focus is wanted.
-
-## を
-
-This particle is used for the target of the action of a verb.
-
-> [!info] Examples
-> ケーキ==を==作る。
-> I prepare a cake.
-
-## に
-
-This particle has multiple meanings.
-
-* A place of existence.
-> [!info] Example
-> {会社|かいしゃ}は東京==に==あります。
-> The company is in Tokyo.
-
-* A point in time.
-> [!info] Example
-> 毎日１２時==に=={寝|ね}ます。
-> I sleep at 12:00 everyday.
-
-* A direction towards whom an action is directed. For example: meeting a person, phoning to someone, riding a transport, writing on something, sitting on something, etc.
-> [!info] Example
-> 日本==に=={住|す}んでいます。
-> I live in Japan.
-
-## に・へ
-
-に and へ are used to indicate a direction of movement with verbs like 行く, くる, and 帰る.
-
-> [!info] Example
- > 日本==へ==行きます。
- > 日本==に==行きます。
- > I'm going to Japan.
-
-## で
-
-This particle can indicate several things.
-
-* A place where the action is done.
-> [!info] Example
-> {図書館|としょかん}==で==本を{読|よ}みました。
-> I read a book in the library.
-
-* The use of something
-> [!info] Example
-> えんぴつ==で==書いてください。
-> Please write with a pencil.
-  
-* The use of ingredients or materials
-> [!info] Example
-> タコ==で==たこ{焼|や}きを作る。
-> I prepare takoyaki with octopus.
-  
-* Numbers or volume for multiple objects.
-> [!info] Example
-> 本を５{冊|さつ}==で==買った。
-> I bought 5 books.
-
-* A noun that is the cause of something. 
-> [!info] Example
-> かぜ==で==休みました。
-> I took the day off because of a cold.
-  
-* A mode of transportation.
-> [!info] Example
-> {休暇|きゅうか}に電車==で==行った。
-> I went on holiday by train.
-
-## の
-
-This particle indicates possession.
-
-> [!info] Example
-> 私==の==ボール。
-> My ball.
-
-## も
-
-This particle means "also".
-
-> [!info] Example
-> 日本{料理|りょうり}==も=={韓国|かん|こく}{料理|りょうり}==も==食べます。
-> I eat Japanese and Korean food.
-
-The particles は, が and を change to も.
-
-> [!info] Example
-> 私は{中国|ちゅう|ごく}語==も==話せます。
-> I can also speak Chinese.
-
-In other cases, it can be combined with other particles: に, で, へ, と, から. 
-
-> [!info] Example
-> {大阪|おお|さか}に==も==行きたい。
-> I also want to go to Osaka.
-
-Another meaning of this particle can be found when combined with words like {何|なに}, {誰|だれ}, or どこ (what, who, where). It means nothing, nobody and nowhere. It indicates the absence.
-
-> [!info] Example
-> A: {昨日|きのう}どこかへ行った？
-> B: いいえ、どこへ==も==行かなかった。
-> A: Did you go somewhere yesterday?
-> B: No, I didn't go anywhere.
-
-Used with a number or a time, it means "as many as" or "nearly".
-
-> [!info] Example
-> 2時間==も=={待|ま}っていました。
-> I have waited for nearly 2 hours.

content/🔰 Grammar/🔰 Particles (2).md

@@ -1,73 +0,0 @@
-# Particles (2)
-
-## から
-
-### Because
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">V</span></p>
-	<p><span class="box">い-Adj</span></p>
-	<p><span class="box">な-Adj + だ</span></p>
-	<p><span class="box">N + だ</span></p>
-</div>
-	<p class="right">+ から</p>
-</div>
-
-The first meaning of から is "because".
-
-> [!info] Example
-> {疲|つか}れる==から==今ベットに行きます。
-> I'm going to bed now because I am tired.
-
-### From, since
-
-The second meaning expresses that something comes from someone/something, or the start time/location. Used by only adding から.
-
-> [!info] Example
-> お{祖母|ばあ}さん==から==もらった。
-> I got it from my grandmother.
-> 
-> ここで{子供|こども}の時==から=={家族|かぞく}と{住|す}んでいます。
-> I have lived here with my family since I'm a kid.
-
-## まで
-
-Means "until" or "to".
-
-> [!info] Example
-> {駅|えき}==まで==どのくらいですか。
-> How far is it to the station?
-
-## から～まで
-
-These two particles are frequently used together. It means "from X to Y".
-
-> [!info] Example
-> {朝|あさ}に６時==から==７時==まで==電車で{通|かよ}うっています。
-> I commute by train from 6am to 7am.
-
-## だけ
-
-Means "only", "just".
-
-> [!info] Example
-> {一|ひと}つ==だけ==ください。
-> Only one, please.
-
-### だけで
-
-Means "just by doing". 
-
-> [!info] Example
-> 見る==だけ==で{楽|たの}しいですね。
-> Just looking at it is fun, isn't it.
-
-## Sentence ending
-
-At the end of a sentence, some particles can be added to put emphasis on a meaning.
-
-* ==なあ== express hope, admiration or uncertainty. Can also be used to ask for confirmation ("right?").
-* ==ね== seeks confirmation.
-* ==よ== when informing someone about something.
-* ==わ== is informal women's speech.

custom/build-run.sh

@@ -1,2 +0,0 @@
-docker build -t quartz-jpg .
-cd custom && docker-compose up -d --force-recreate

custom/convert-furigana/LICENSE

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) 2024 keb
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

custom/convert-furigana/README.md

@@ -1,43 +0,0 @@
-# convert-furigana
-
-## What is it?
-
-There are a few extensions that add [furigana](https://en.wikipedia.org/wiki/Furigana) support to Markdown. I use [Obsidian](https://obsidian.md/), and therefore its furigana extension: [obsidian-markdown-furigana](https://github.com/steven-kraft/obsidian-markdown-furigana). It works well, but by nature is limited by being used within Obsidian.
-
-For that purpose, this python script converts this specific syntax to common, all-platforms HTML ruby tags.
-
-## Process
-
-This specific extension syntax is as following:
-```
-{漢字|かんじ}
-{漢字|かん|じ}
-```
-
-When processed by this script, the result is:
-```
-<ruby>漢字<rt>かんじ</rt></ruby>
-<ruby>漢<rt>かん</rt>字<rt>じ</rt></ruby>
-```
-
-Which leads visually from, by default markdown standards:
-
-> {漢字|かんじ}
->
-> {漢字|かん|じ}
-
-to common HTML ruby syntax:
-
-> <ruby>漢字<rt>かんじ</rt></ruby>
->
-> <ruby>漢<rt>かん</rt>字<rt>じ</rt></ruby>
-
-## Limitations
-
-This has been made for my personal use, which is only kanjis with kanas as furigana. The regexp used do not recognize other inputs. But you can modify them easily for your use if needed.
-
-## Usage
-
-Usage: `python3 convert-furigana.py [root folder]`
-
-Note: Please be careful, this software applies modifications recursively!

custom/convert-furigana/examples/furigana1.md

@@ -1,6 +0,0 @@
-{僕|ボク}の{筆記|ひっ|き}
-
-### ～によるN
-
-* テレビによる{報道|ほうどう}
-* この{地震|じ|しん}による{津波|つ|なみ}の{心配|しんぱい}はありません。

custom/convert-furigana/examples/subfolder/furigana2.md

@@ -1,7 +0,0 @@
-## ふりがなテスト
-
-{漢字|かんじ}
-
-{漢字|かん|じ}
-
-{漢字|カン|ジ}

custom/convert-furigana/program/convert-furigana.py

@@ -1,71 +0,0 @@
-import sys
-import os
-from glob import glob
-import re
-
-### Patterns ###
-
-# https://www.reddit.com/r/learnpython/comments/h0tsaa/regex_expression_for_japanese_extracting/
-re_brace = '{(.+?)}'
-re_kanji = '([㐀-䶵一-鿋豈-頻々]+)'
-re_kana = '([ぁ-ゟ゠-ヿ]+)'
-
-### Open file ###
-
-def open_file(filename):
-    with open(filename, 'r', encoding='utf-8-sig') as file:
-        filedata = file.read()
-        return filedata
-
-### Replace ###
-
-def write_ruby_simple(kanji, kana):
-    return f"<ruby>{kanji}<rt>{kana}</rt></ruby>"
-
-def write_ruby_multiple(kanji, kanas):
-    result = f"<ruby>"
-    for idx, kana in enumerate(kanas):
-        result += f"{kanji[idx]}"
-        result += f"<rt>{kana}</rt>"
-    result += f"</ruby>"
-    return result
-
-def convert_to_ruby(content):
-    kanji = re.search(re_kanji, content.group())
-    kana = re.findall(re_kana, content.group())
-
-    if (len(kana) == 1):
-        return write_ruby_simple(kanji.group(), kana[0])
-    else:
-        return write_ruby_multiple(kanji.group(), kana)
-
-def convert_pattern(text):
-    res_text = re.sub(re_brace, convert_to_ruby, text)
-    return res_text
-
-### Write to file ###
-
-def write_file(filename, text):
-    with open(filename, 'w', encoding='utf-8-sig') as file:
-        file.write(text)
-
-
-### Execution ###
-
-file_list = []
-
-if len(sys.argv) > 1:
-    path = sys.argv[1]
-    for filename in glob(path + "/**/*.md", recursive=True):
-        if (os.path.isfile(filename)):
-            file_list.append(filename)
-else:
-    print(f"Usage: python3 {sys.argv[0]} [root folder]")
-    print(f"Note: Please be careful, this software applies modifications recursively!")
-
-for filename in file_list:
-    print(f"Found file {filename}, processing...", end='')
-    data = open_file(filename)
-    text = convert_pattern(data)
-    write_file(filename, text)
-    print(f" done!")

custom/convert-usage/LICENSE

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) 2024 keb
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

custom/convert-usage/README.md

@@ -1,17 +0,0 @@
-# convert-usage
-
-## Obsidian snippet
-
-For my Japanese Grammar (JPG) project, I have created a style for explanation on the usage of certain grammar points. There is no simple way to make it in Markdown, so I tried to make it with the least amount of HTML possible. You can find it in `examples/sample.md`. However, for it to work, you have to import a custom [CSS snippet](https://help.obsidian.md/Extending+Obsidian/CSS+snippets) to Obsidian, which is located in `obsidian-snippet/usage.css`. But using it, you will have this kind of result:
-
-![Obsidian screenshot](./screenshot.png)
-
-## convert-usage.py
-
-In my Quartz rendering of my markdown data, I want this kind of data to be in a callout. However, it is not possible to combine HTML and Markdown in Obsidian. For that purpose, this script encapsulates it directly in HTML. To make it both compatible in Obsidian and Quartz, and to be still easy to write, it's done with this python script. This is probably super specific and will not be of use for anybody except me!
-
-## Usage
-
-Usage: `python3 convert-usage.py [root folder]`
-
-Note: Please be careful, this software applies modifications recursively!

custom/convert-usage/examples/sample.md

@@ -1,33 +0,0 @@
-# test file
-
-## Lorem ipsum
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris massa eros, feugiat eu dapibus nec, fermentum vel ex. Nulla malesuada luctus pretium. Phasellus ac felis ut nisi lacinia malesuada nec vel odio. Donec tincidunt tincidunt lorem vel tempus. Nullam sed efficitur ligula, a porttitor nibh. Praesent justo dui, venenatis ac mi non, laoreet consequat libero. Aenean ut molestie mauris. Proin mattis volutpat ligula eget tincidunt. Fusce ex eros, condimentum consectetur efficitur vitae, euismod at justo.
-
-**Usage**
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">item1</span></p>
-	<p><span class="box">item2</span></p>
-	<p><span class="box">item3</span></p>
-	<p><span class="box">item4</span></p>
-</div>
-	<p class="right">+ final</p>
-</div>
-
-## Phasellus tristique
-
-Phasellus tristique rutrum enim. Integer vitae ex at turpis convallis posuere nec nec erat. Cras finibus erat mauris. Suspendisse id diam at sapien luctus faucibus. Pellentesque fermentum auctor libero, ut porta orci porttitor quis. In varius at sem sed ultricies. Mauris iaculis convallis erat, congue tincidunt turpis luctus vitae.
-
-**Usage**
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">アイテム１</span></p>
-	<p><span class="box">アイテム２</span></p>
-	<p><span class="box">アイテム３</span></p>
-	<p><span class="box">アイテム４</span></p>
-</div>
-	<p class="right">＋ ファイナル</p>
-</div>

custom/convert-usage/examples/sample2.md

@@ -1,23 +0,0 @@
-# test file
-
-## Lorem ipsum
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris massa eros, feugiat eu dapibus nec, fermentum vel ex. Nulla malesuada luctus pretium. Phasellus ac felis ut nisi lacinia malesuada nec vel odio. Donec tincidunt tincidunt lorem vel tempus. Nullam sed efficitur ligula, a porttitor nibh. Praesent justo dui, venenatis ac mi non, laoreet consequat libero. Aenean ut molestie mauris. Proin mattis volutpat ligula eget tincidunt. Fusce ex eros, condimentum consectetur efficitur vitae, euismod at justo.
-
-**Usage**
-
-<div class="usage">
-<div class="left">
-	<p><span class="box">item1</span></p>
-	<p><span class="box">item2</span></p>
-	<p><span class="box">item3</span></p>
-	<p><span class="box">item4</span></p>
-</div>
-	<p class="right">+ final</p>
-</div>
-
-## Callout
-
-> [!info] Example
-> Callout example
-> Careful with BS4 encoding some characters

custom/convert-usage/obsidian-snippets/usage.css

@@ -1,35 +0,0 @@
-.box {
-    display: inline-block;
-    width: fit-content;
-    margin: 0.2rem;
-    padding: 0.2rem 0.3rem 0.2rem 0.3rem;
-
-    border: 1px solid black;
-    border-radius: 0.5rem;
-}
-
-.usage {
-    display:flex;
-    flex-direction: row;
-    align-items: center;
-}
-
-.left {
-    padding-right: 1.7rem;
-
-    background-image: linear-gradient(black, black), linear-gradient(black, black);
-    background-repeat: no-repeat;
-    background-size: 8px 2px;
-    background-position: top right, bottom right;
-
-    border-right: solid black;
-    border-width: 0 2px;
-}
-
-.left p {
-    margin:0;
-}
-
-.right {
-    padding-left: 1rem;
-}

custom/convert-usage/program/convert-usage.py

@@ -1,66 +0,0 @@
-import sys
-import os
-from glob import glob
-from bs4 import BeautifulSoup
-import re
-
-### Patterns ###
-
-re_usage = r'(^\*\*Usage\*\*$\n\n)'
-callout_title_html = '''
-    <div class="callout-title">
-        <div class="callout-icon"></div>
-        <div class="callout-title-inner"><p>Usage</p></div>
-    </div>'''
-
-### Open file ###
-
-def open_file(filename):
-    with open(filename, 'r', encoding='utf-8-sig') as file:
-        filedata = file.read()
-        return filedata
-
-### Write to file ###
-
-def write_file(filename, text):
-    with open(filename, 'w', encoding='utf-8-sig') as file:
-        file.write(text)
-
-### Replace ###
-
-def convert_pattern(text):
-    text, success = re.subn(re_usage, '', text, flags=re.MULTILINE)
-    if (success == 0):
-        return text
-
-    soup = BeautifulSoup(text, features="html.parser")
-
-    for tag in soup.find_all('div', {"class": "usage"}):
-        new_blockquote = soup.new_tag("blockquote", **{"class": "callout notes", "data-callout": "notes"})
-        tag.wrap(new_blockquote)
-
-        calloutTitle = BeautifulSoup(callout_title_html, features="html.parser")
-        tag.insert_before(calloutTitle)
-
-    return (soup.decode(False, formatter=None))
-
-
-### Execution ###
-
-file_list = []
-
-if len(sys.argv) > 1:
-    path = sys.argv[1]
-    for filename in glob(path + "/**/*.md", recursive=True):
-        if (os.path.isfile(filename)):
-            file_list.append(filename)
-else:
-    print(f"Usage: python3 {sys.argv[0]} [root folder]")
-    print(f"Note: Please be careful, this software applies modifications recursively!")
-
-for filename in file_list:
-    print(f"Found file {filename}, processing...", end='')
-    data = open_file(filename)
-    text = convert_pattern(data)
-    write_file(filename, text)
-    print(f" done!")

custom/docker-compose.yml

@@ -1,14 +0,0 @@
-version: '3.4'
-
-services:
-  quartz:
-    image: quartz-jpg
-    build:
-      context: .
-      dockerfile: Dockerfile
-    environment:
-      NODE_ENV: production
-    container_name: quartz-jpg-container
-    restart: always
-    ports:
-      - 8080:8080

custom/update-repos.sh

@@ -1,8 +0,0 @@
-git fetch convert-furigana main
-git subtree pull --prefix custom/convert-furigana convert-furigana main --squash
-
-git fetch convert-usage main
-git subtree pull --prefix custom/convert-usage convert-usage main --squash
-
-git fetch content main
-git subtree pull --prefix content content main --squash

docs/advanced/creating components.md

@@ -129,11 +129,11 @@ export default (() => {
     return <button id="btn">Click me</button>
   }
 
-  YourComponent.beforeDOM = `
+  YourComponent.beforeDOMLoaded = `
   console.log("hello from before the page loads!")
   `
 
-  YourComponent.afterDOM = `
+  YourComponent.afterDOMLoaded = `
   document.getElementById('btn').onclick = () => {
     alert('button clicked!')
   }
@@ -161,6 +161,18 @@ document.addEventListener("nav", () => {
 })
 ```
 
+You can also add the equivalent of a `beforeunload` event for [[SPA Routing]] via the `prenav` event.
+
+```ts
+document.addEventListener("prenav", () => {
+  // executed after an SPA navigation is triggered but
+  // before the page is replaced
+  // one usage pattern is to store things in sessionStorage
+  // in the prenav and then conditionally load then in the consequent
+  // nav
+})
+```
+
 It is best practice to track any event handlers via `window.addCleanup` to prevent memory leaks.
 This will get called on page navigation.
 
@@ -180,7 +192,7 @@ export default (() => {
     return <button id="btn">Click me</button>
   }
 
-  YourComponent.afterDOM = script
+  YourComponent.afterDOMLoaded = script
   return YourComponent
 }) satisfies QuartzComponentConstructor
 ```

docs/advanced/making plugins.md

@@ -25,10 +25,11 @@ The following sections will go into detail for what methods can be implemented f
 - `BuildCtx` is defined in `quartz/ctx.ts`. It consists of
   - `argv`: The command line arguments passed to the Quartz [[build]] command
   - `cfg`: The full Quartz [[configuration]]
-  - `allSlugs`: a list of all the valid content slugs (see [[paths]] for more information on what a `ServerSlug` is)
+  - `allSlugs`: a list of all the valid content slugs (see [[paths]] for more information on what a slug is)
 - `StaticResources` is defined in `quartz/resources.tsx`. It consists of
-  - `css`: a list of URLs for stylesheets that should be loaded
+  - `css`: a list of CSS style definitions that should be loaded. A CSS style is described with the `CSSResource` type which is also defined in `quartz/resources.tsx`. It accepts either a source URL or the inline content of the stylesheet.
   - `js`: a list of scripts that should be loaded. A script is described with the `JSResource` type which is also defined in `quartz/resources.tsx`. It allows you to define a load time (either before or after the DOM has been loaded), whether it should be a module, and either the source URL or the inline content of the script.
+  - `additionalHead`: a list of JSX elements or functions that return JSX elements to be added to the `<head>` tag of the page. Functions receive the page's data as an argument and can conditionally render elements.
 
 ## Transformers
 
@@ -37,7 +38,7 @@ Transformers **map** over content, taking a Markdown file and outputting modifie
 ```ts
 export type QuartzTransformerPluginInstance = {
   name: string
-  textTransform?: (ctx: BuildCtx, src: string | Buffer) => string | Buffer
+  textTransform?: (ctx: BuildCtx, src: string) => string
   markdownPlugins?: (ctx: BuildCtx) => PluggableList
   htmlPlugins?: (ctx: BuildCtx) => PluggableList
   externalResources?: (ctx: BuildCtx) => Partial<StaticResources>
@@ -85,8 +86,10 @@ export const Latex: QuartzTransformerPlugin<Options> = (opts?: Options) => {
       if (engine === "katex") {
         return {
           css: [
-            // base css
+            {
-            "https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.css",
+              // base css
+              content: "https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.css",
+            },
           ],
           js: [
             {
@@ -97,8 +100,6 @@ export const Latex: QuartzTransformerPlugin<Options> = (opts?: Options) => {
             },
           ],
         }
-      } else {
-        return {}
       }
     },
   }
@@ -220,12 +221,26 @@ export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
 
 export type QuartzEmitterPluginInstance = {
   name: string
-  emit(ctx: BuildCtx, content: ProcessedContent[], resources: StaticResources): Promise<FilePath[]>
+  emit(
+    ctx: BuildCtx,
+    content: ProcessedContent[],
+    resources: StaticResources,
+  ): Promise<FilePath[]> | AsyncGenerator<FilePath>
+  partialEmit?(
+    ctx: BuildCtx,
+    content: ProcessedContent[],
+    resources: StaticResources,
+    changeEvents: ChangeEvent[],
+  ): Promise<FilePath[]> | AsyncGenerator<FilePath> | null
   getQuartzComponents(ctx: BuildCtx): QuartzComponent[]
 }
 ```
 
-An emitter plugin must define a `name` field, an `emit` function, and a `getQuartzComponents` function. `emit` is responsible for looking at all the parsed and filtered content and then appropriately creating files and returning a list of paths to files the plugin created.
+An emitter plugin must define a `name` field, an `emit` function, and a `getQuartzComponents` function. It can optionally implement a `partialEmit` function for incremental builds.
+
+- `emit` is responsible for looking at all the parsed and filtered content and then appropriately creating files and returning a list of paths to files the plugin created.
+- `partialEmit` is an optional function that enables incremental builds. It receives information about which files have changed (`changeEvents`) and can selectively rebuild only the necessary files. This is useful for optimizing build times in development mode. If `partialEmit` is undefined, it will default to the `emit` function.
+- `getQuartzComponents` declares which Quartz components the emitter uses to construct its pages.
 
 Creating new files can be done via regular Node [fs module](https://nodejs.org/api/fs.html) (i.e. `fs.cp` or `fs.writeFile`) or via the `write` function in `quartz/plugins/emitters/helpers.ts` if you are creating files that contain text. `write` has the following signature:
 
@@ -234,7 +249,7 @@ export type WriteOptions = (data: {
   // the build context
   ctx: BuildCtx
   // the name of the file to emit (not including the file extension)
-  slug: ServerSlug
+  slug: FullSlug
   // the file extension
   ext: `.${string}` | ""
   // the file content to add
@@ -260,11 +275,11 @@ export const ContentPage: QuartzEmitterPlugin = () => {
     ...defaultContentPageLayout,
     pageBody: Content(),
   }
-  const { head, header, beforeBody, pageBody, left, right, footer } = layout
+  const { head, header, beforeBody, pageBody, afterBody, left, right, footer } = layout
   return {
     name: "ContentPage",
     getQuartzComponents() {
-      return [head, ...header, ...beforeBody, pageBody, ...left, ...right, footer]
+      return [head, ...header, ...beforeBody, pageBody, ...afterBody, ...left, ...right, footer]
     },
     async emit(ctx, content, resources, emit): Promise<FilePath[]> {
       const cfg = ctx.cfg.configuration
@@ -272,7 +287,7 @@ export const ContentPage: QuartzEmitterPlugin = () => {
       const allFiles = content.map((c) => c[1].data)
       for (const [tree, file] of content) {
         const slug = canonicalizeServer(file.data.slug!)
-        const externalResources = pageResources(slug, resources)
+        const externalResources = pageResources(slug, file.data, resources)
         const componentData: QuartzComponentProps = {
           fileData: file.data,
           externalResources,

docs/advanced/paths.md

@@ -48,4 +48,4 @@ Here are the main types of slugs with a rough description of each type of path:
 - `SimpleSlug`: cannot be relative and shouldn't have `/index` as an ending or a file extension. It _can_ however have a trailing slash to indicate a folder path.
 - `RelativeURL`: must start with `.` or `..` to indicate it's a relative URL. Shouldn't have `/index` as an ending or a file extension but can contain a trailing slash.
 
-To get a clearer picture of how these relate to each other, take a look at the path tests in `quartz/path.test.ts`.
+To get a clearer picture of how these relate to each other, take a look at the path tests in `quartz/util/path.test.ts`.

docs/authoring content.md

@@ -29,11 +29,14 @@ 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.
 - `description`: Description of the page used for link previews.
+- `permalink`: A custom URL for the page that will remain constant even if the path to the file changes.
 - `aliases`: Other names for this note. This is a list of strings.
 - `tags`: Tags for this note.
 - `draft`: Whether to publish the page or not. This is one way to make [[private pages|pages private]] in Quartz.
 - `date`: A string representing the day the note was published. Normally uses `YYYY-MM-DD` format.
 
+See [[Frontmatter]] for a complete list of frontmatter.
+
 ## Syncing your Content
 
 When your Quartz is at a point you're happy with, you can save your changes to GitHub.

docs/build.md

@@ -21,3 +21,7 @@ This will start a local web server to run your Quartz on your computer. Open a w
 > - `--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
+
+> [!warning] Not to be used for production
+> Serve mode is intended for local previews only.
+> For production workloads, see the page on [[hosting]].

docs/configuration.md

@@ -21,16 +21,19 @@ const config: QuartzConfig = {
 This part of the configuration concerns anything that can affect the whole site. The following is a list breaking down all the things you can configure:
 
 - `pageTitle`: title of the site. This is also used when generating the [[RSS Feed]] for your site.
+- `pageTitleSuffix`: a string added to the end of the page title. This only applies to the browser tab title, not the title shown at the top of the page.
 - `enableSPA`: whether to enable [[SPA Routing]] on your site.
 - `enablePopovers`: whether to enable [[popover previews]] on your site.
 - `analytics`: what to use for analytics on your site. Values can be
   - `null`: don't use analytics;
   - `{ provider: 'google', tagId: '<your-google-tag>' }`: use Google Analytics;
-  - `{ provider: 'plausible' }` (managed) or `{ provider: 'plausible', host: '<your-plausible-host>' }` (self-hosted): use [Plausible](https://plausible.io/);
+  - `{ provider: 'plausible' }` (managed) or `{ provider: 'plausible', host: 'https://<your-plausible-host>' }` (self-hosted, make sure to include the `https://` protocol prefix): use [Plausible](https://plausible.io/);
   - `{ provider: 'umami', host: '<your-umami-host>', websiteId: '<your-umami-website-id>' }`: use [Umami](https://umami.is/);
   - `{ provider: 'goatcounter', websiteId: 'my-goatcounter-id' }` (managed) or `{ provider: 'goatcounter', websiteId: 'my-goatcounter-id', host: 'my-goatcounter-domain.com', scriptSrc: 'https://my-url.to/counter.js' }` (self-hosted) use [GoatCounter](https://goatcounter.com);
   - `{ provider: 'posthog', apiKey: '<your-posthog-project-apiKey>', host: '<your-posthog-host>' }`: use [Posthog](https://posthog.com/);
   - `{ provider: 'tinylytics', siteId: '<your-site-id>' }`: use [Tinylytics](https://tinylytics.app/);
+  - `{ provider: 'cabin' }` or `{ provider: 'cabin', host: 'https://cabin.example.com' }` (custom domain): use [Cabin](https://withcabin.com);
+  - `{provider: 'clarity', projectId: '<your-clarity-id-code' }`: use [Microsoft clarity](https://clarity.microsoft.com/). The project id can be found on top of the overview page.
 - `locale`: used for [[i18n]] and date formatting
 - `baseUrl`: this is used for sitemaps and RSS feeds that require an absolute URL to know where the canonical 'home' of your site lives. This is normally the deployed URL of your site (e.g. `quartz.jzhao.xyz` for this site). Do not include the protocol (i.e. `https://`) or any leading or trailing slashes.
   - This should also include the subpath if you are [[hosting]] on GitHub pages without a custom domain. For example, if my repository is `jackyzha0/quartz`, GitHub pages would deploy to `https://jackyzha0.github.io/quartz` and the `baseUrl` would be `jackyzha0.github.io/quartz`.
@@ -38,11 +41,12 @@ This part of the configuration concerns anything that can affect the whole site.
 - `ignorePatterns`: a list of [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) patterns that Quartz should ignore and not search through when looking for files inside the `content` folder. See [[private pages]] for more details.
 - `defaultDateType`: whether to use created, modified, or published as the default date to display on pages and page listings.
 - `theme`: configure how the site looks.
-  - `cdnCaching`: If `true` (default), use Google CDN to cache the fonts. This will generally will be faster. Disable (`false`) this if you want Quartz to download the fonts to be self-contained.
+  - `cdnCaching`: if `true` (default), use Google CDN to cache the fonts. This will generally be faster. Disable (`false`) this if you want Quartz to download the fonts to be self-contained.
   - `typography`: what fonts to use. Any font available on [Google Fonts](https://fonts.google.com/) works here.
-    - `header`: Font to use for headers
+    - `title`: font for the title of the site (optional, same as `header` by default)
-    - `code`: Font for inline and block quotes.
+    - `header`: font to use for headers
-    - `body`: Font for everything
+    - `code`: font for inline and block quotes
+    - `body`: font for everything
   - `colors`: controls the theming of the site.
     - `light`: page background
     - `lightgray`: borders
@@ -52,6 +56,7 @@ This part of the configuration concerns anything that can affect the whole site.
     - `secondary`: link colour, current [[graph view|graph]] node
     - `tertiary`: hover states and visited [[graph view|graph]] nodes
     - `highlight`: internal link background, highlighted text, [[syntax highlighting|highlighted lines of code]]
+    - `textHighlight`: markdown highlighted text background
 
 ## Plugins
 
@@ -99,8 +104,30 @@ transformers: [
 ]
 ```
 
-Some plugins are included by default in the[ `quartz.config.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz.config.ts), but there are more available.
+Some plugins are included by default in the [`quartz.config.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz.config.ts), but there are more available.
 
 You can see a list of all plugins and their configuration options [[tags/plugin|here]].
 
 If you'd like to make your own plugins, see the [[making plugins|making custom plugins]] guide.
+
+## Fonts
+
+Fonts can be specified as a `string` or a `FontSpecification`:
+
+```ts
+// string
+typography: {
+  header: "Schibsted Grotesk",
+  ...
+}
+
+// FontSpecification
+typography: {
+  header: {
+    name: "Schibsted Grotesk",
+    weights: [400, 700],
+    includeItalic: true,
+  },
+  ...
+}
+```

docs/features/Citations.md

@@ -0,0 +1,31 @@
+---
+title: Citations
+tags:
+  - feature/transformer
+---
+
+Quartz uses [rehype-citation](https://github.com/timlrx/rehype-citation) to support parsing of a BibTex bibliography file.
+
+Under the default configuration, a citation key `[@templeton2024scaling]` will be exported as `(Templeton et al., 2024)`.
+
+> [!example]- BibTex file
+>
+> ```bib title="bibliography.bib"
+> @article{templeton2024scaling,
+>   title={Scaling Monosemanticity: Extracting Interpretable Features from Claude 3 Sonnet},
+>   author={Templeton, Adly and Conerly, Tom and Marcus, Jonathan and Lindsey, Jack and Bricken, Trenton and Chen, Brian and Pearce, Adam and Citro, Craig and Ameisen, Emmanuel and Jones, Andy and Cunningham, Hoagy and Turner, Nicholas L and McDougall, Callum and MacDiarmid, Monte and Freeman, C. Daniel and Sumers, Theodore R. and Rees, Edward and Batson, Joshua and Jermyn, Adam and Carter, Shan and Olah, Chris and Henighan, Tom},
+>   year={2024},
+>   journal={Transformer Circuits Thread},
+>   url={https://transformer-circuits.pub/2024/scaling-monosemanticity/index.html}
+> }
+> ```
+
+> [!note] Behaviour of references
+>
+> By default, the references will be included at the end of the file. To control where the references to be included, uses `[^ref]`
+>
+> Refer to `rehype-citation` docs for more information.
+
+## Customization
+
+Citation parsing is a functionality of the [[plugins/Citations|Citation]] plugin. **This plugin is not enabled by default**. See the plugin page for customization options.

docs/features/Docker Support.md

@@ -3,5 +3,5 @@ Quartz comes shipped with a Docker image that will allow you to preview your Qua
 You can run the below one-liner to run Quartz in Docker.
 
 ```sh
-docker run --rm -itp 8080:8080 $(docker build -q .)
+docker run --rm -itp 8080:8080 -p 3001:3001 -v ./content:/usr/src/app/content $(docker build -q .)
 ```

docs/features/RSS Feed.md

@@ -1,5 +1,10 @@
 Quartz emits an RSS feed for all the content on your site by generating an `index.xml` file that RSS readers can subscribe to. Because of the RSS spec, this requires the `baseUrl` property in your [[configuration]] to be set properly for RSS readers to pick it up properly.
 
+> [!info]
+> After deploying, the generated RSS link will be available at `https://${baseUrl}/index.xml` by default.
+>
+> The `index.xml` path can be customized by passing the `rssSlug` option to the [[ContentIndex]] plugin.
+
 ## Configuration
 
 This functionality is provided by the [[ContentIndex]] plugin. See the plugin page for customization options.

docs/features/Roam Research compatibility.md

@@ -0,0 +1,28 @@
+---
+title: "Roam Research Compatibility"
+tags:
+  - feature/transformer
+---
+
+[Roam Research](https://roamresearch.com) is a note-taking tool that organizes your knowledge graph in a unique and interconnected way.
+
+Quartz supports transforming the special Markdown syntax from Roam Research (like `{{[[components]]}}` and other formatting) into
+regular Markdown via the [[RoamFlavoredMarkdown]] plugin.
+
+```typescript title="quartz.config.ts"
+plugins: {
+  transformers: [
+    // ...
+    Plugin.RoamFlavoredMarkdown(),
+    Plugin.ObsidianFlavoredMarkdown(),
+    // ...
+  ],
+},
+```
+
+> [!warning]
+> As seen above placement of `Plugin.RoamFlavoredMarkdown()` within `quartz.config.ts` is very important. It must come before `Plugin.ObsidianFlavoredMarkdown()`.
+
+## Customization
+
+This functionality is provided by the [[RoamFlavoredMarkdown]] plugin. See the plugin page for customization options.

docs/features/backlinks.md

@@ -9,6 +9,7 @@ A backlink for a note is a link from another note to that note. Links in the bac
 ## Customization
 
 - Removing backlinks: delete all usages of `Component.Backlinks()` from `quartz.layout.ts`.
+- Hide when empty: hide `Backlinks` if given page doesn't contain any backlinks (default to `true`). To disable this, use `Component.Backlinks({ hideWhenEmpty: false })`.
 - Component: `quartz/components/Backlinks.tsx`
 - Style: `quartz/components/styles/backlinks.scss`
 - Script: `quartz/components/scripts/search.inline.ts`

docs/features/breadcrumbs.md

@@ -19,7 +19,6 @@ Component.Breadcrumbs({
   spacerSymbol: "❯", // symbol between crumbs
   rootName: "Home", // name of first/root element
   resolveFrontmatterTitle: true, // whether to resolve folder names through frontmatter titles
-  hideOnRoot: true, // whether to hide breadcrumbs on root `index.md` page
   showCurrentPage: true, // whether to display the current page in the breadcrumbs
 })
 ```

docs/features/comments.md

@@ -0,0 +1,133 @@
+---
+title: Comments
+tags:
+  - component
+---
+
+Quartz also has the ability to hook into various providers to enable readers to leave comments on your site.
+
+![[giscus-example.png]]
+
+As of today, only [Giscus](https://giscus.app/) is supported out of the box but PRs to support other providers are welcome!
+
+## Providers
+
+### Giscus
+
+First, make sure that the [[setting up your GitHub repository|GitHub]] repository you are using for your Quartz meets the following requirements:
+
+1. The **repository is [public](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/setting-repository-visibility#making-a-repository-public)**, otherwise visitors will not be able to view the discussion.
+2. The **[giscus](https://github.com/apps/giscus) app is installed**, otherwise visitors will not be able to comment and react.
+3. The **Discussions feature is turned on** by [enabling it for your repository](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/enabling-or-disabling-github-discussions-for-a-repository).
+
+Then, use the [Giscus site](https://giscus.app/#repository) to figure out what your `repoId` and `categoryId` should be. Make sure you select `Announcements` for the Discussion category.
+
+![[giscus-repo.png]]
+
+![[giscus-discussion.png]]
+
+After entering both your repository and selecting the discussion category, Giscus will compute some IDs that you'll need to provide back to Quartz. You won't need to manually add the script yourself as Quartz will handle that part for you but will need these values in the next step!
+
+![[giscus-results.png]]
+
+Finally, in `quartz.layout.ts`, edit the `afterBody` field of `sharedPageComponents` to include the following options but with the values you got from above:
+
+```ts title="quartz.layout.ts"
+afterBody: [
+  Component.Comments({
+    provider: 'giscus',
+    options: {
+      // from data-repo
+      repo: 'jackyzha0/quartz',
+      // from data-repo-id
+      repoId: 'MDEwOlJlcG9zaXRvcnkzODcyMTMyMDg',
+      // from data-category
+      category: 'Announcements',
+      // from data-category-id
+      categoryId: 'DIC_kwDOFxRnmM4B-Xg6',
+      // from data-lang
+      lang: 'en'
+    }
+  }),
+],
+```
+
+### Customization
+
+Quartz also exposes a few of the other Giscus options as well and you can provide them the same way `repo`, `repoId`, `category`, and `categoryId` are provided.
+
+```ts
+type Options = {
+  provider: "giscus"
+  options: {
+    repo: `${string}/${string}`
+    repoId: string
+    category: string
+    categoryId: string
+
+    // Url to folder with custom themes
+    // defaults to 'https://${cfg.baseUrl}/static/giscus'
+    themeUrl?: string
+
+    // filename for light theme .css file
+    // defaults to 'light'
+    lightTheme?: string
+
+    // filename for dark theme .css file
+    // defaults to 'dark'
+    darkTheme?: string
+
+    // how to map pages -> discussions
+    // defaults to 'url'
+    mapping?: "url" | "title" | "og:title" | "specific" | "number" | "pathname"
+
+    // use strict title matching
+    // defaults to true
+    strict?: boolean
+
+    // whether to enable reactions for the main post
+    // defaults to true
+    reactionsEnabled?: boolean
+
+    // where to put the comment input box relative to the comments
+    // defaults to 'bottom'
+    inputPosition?: "top" | "bottom"
+
+    // set your preference language here
+    // defaults to 'en'
+    lang?: string
+  }
+}
+```
+
+#### Custom CSS theme
+
+Quartz supports custom theme for Giscus. To use a custom CSS theme, place the `.css` file inside the `quartz/static` folder and set the configuration values.
+
+For example, if you have a light theme `light-theme.css`, a dark theme `dark-theme.css`, and your Quartz site is hosted at `https://example.com/`:
+
+```ts
+afterBody: [
+  Component.Comments({
+    provider: 'giscus',
+    options: {
+      // Other options
+
+      themeUrl: "https://example.com/static/giscus", // corresponds to quartz/static/giscus/
+      lightTheme: "light-theme", // corresponds to light-theme.css in quartz/static/giscus/
+      darkTheme: "dark-theme", // corresponds to dark-theme.css quartz/static/giscus/
+    }
+  }),
+],
+```
+
+#### Conditionally display comments
+
+Quartz can conditionally display the comment box based on a field `comments` in the frontmatter. By default, all pages will display comments, to disable it for a specific page, set `comments` to `false`.
+
+```
+---
+title: Comments disabled here!
+comments: false
+---
+```

docs/features/explorer.md

@@ -27,12 +27,10 @@ Component.Explorer({
   folderClickBehavior: "collapse", // what happens when you click a folder ("link" to navigate to folder page on click or "collapse" to collapse folder on click)
   folderDefaultState: "collapsed", // default state of folders ("collapsed" or "open")
   useSavedState: true, // whether to use local storage to save "state" (which folders are opened) of explorer
-  // Sort order: folders first, then files. Sort folders and files alphabetically
+  // omitted but shown later
-  sortFn: (a, b) => {
+  sortFn: ...,
-    ... // default implementation shown later
+  filterFn: ...,
-  },
+  mapFn: ...,
-  filterFn: filterFn: (node) => node.name !== "tags", // filters out 'tags' folder
-  mapFn: undefined,
   // what order to apply functions in
   order: ["filter", "map", "sort"],
 })
@@ -45,26 +43,30 @@ Want to customize it even more?
 - Removing explorer: remove `Component.Explorer()` from `quartz.layout.ts`
   - (optional): After removing the explorer component, you can move the [[table of contents | Table of Contents]] component back to the `left` part of the layout
 - Changing `sort`, `filter` and `map` behavior: explained in [[#Advanced customization]]
-- Component:
+- Component: `quartz/components/Explorer.tsx`
-  - Wrapper (Outer component, generates file tree, etc): `quartz/components/Explorer.tsx`
-  - Explorer node (recursive, either a folder or a file): `quartz/components/ExplorerNode.tsx`
 - Style: `quartz/components/styles/explorer.scss`
 - Script: `quartz/components/scripts/explorer.inline.ts`
 
 ## Advanced customization
 
 This component allows you to fully customize all of its behavior. You can pass a custom `sort`, `filter` and `map` function.
-All functions you can pass work with the `FileNode` class, which has the following properties:
+All functions you can pass work with the `FileTrieNode` class, which has the following properties:
 
-```ts title="quartz/components/ExplorerNode.tsx" {2-5}
+```ts title="quartz/components/Explorer.tsx"
-export class FileNode {
+class FileTrieNode {
-  children: FileNode[]  // children of current node
+  isFolder: boolean
-  name: string  // last part of slug
+  children: Array<FileTrieNode>
-  displayName: string // what actually should be displayed in the explorer
+  data: ContentDetails | null
-  file: QuartzPluginData | null // if node is a file, this is the file's metadata. See `QuartzPluginData` for more detail
+}
-  depth: number // depth of current node
+```
 
-  ... // rest of implementation
+```ts title="quartz/plugins/emitters/contentIndex.tsx"
+export type ContentDetails = {
+  slug: FullSlug
+  title: string
+  links: SimpleSlug[]
+  tags: string[]
+  content: string
 }
 ```
 
@@ -74,15 +76,14 @@ Every function you can pass is optional. By default, only a `sort` function will
 // Sort order: folders first, then files. Sort folders and files alphabetically
 Component.Explorer({
   sortFn: (a, b) => {
-    if ((!a.file && !b.file) || (a.file && b.file)) {
+    if ((!a.isFolder && !b.isFolder) || (a.isFolder && b.isFolder)) {
-      // sensitivity: "base": Only strings that differ in base letters compare as unequal. Examples: a ≠ b, a = á, a = A
-      // numeric: true: Whether numeric collation should be used, such that "1" < "2" < "10"
       return a.displayName.localeCompare(b.displayName, undefined, {
         numeric: true,
         sensitivity: "base",
       })
     }
-    if (a.file && !b.file) {
+
+    if (!a.isFolder && b.isFolder) {
       return 1
     } else {
       return -1
@@ -100,41 +101,23 @@ For more information on how to use `sort`, `filter` and `map`, you can check [Ar
 Type definitions look like this:
 
 ```ts
-sortFn: (a: FileNode, b: FileNode) => number
+type SortFn = (a: FileTrieNode, b: FileTrieNode) => number
-filterFn: (node: FileNode) => boolean
+type FilterFn = (node: FileTrieNode) => boolean
-mapFn: (node: FileNode) => void
+type MapFn = (node: FileTrieNode) => void
 ```
 
-> [!tip]
-> You can check if a `FileNode` is a folder or a file like this:
->
-> ```ts
-> if (node.file) {
->   // node is a file
-> } else {
->   // node is a folder
-> }
-> ```
-
 ## Basic examples
 
 These examples show the basic usage of `sort`, `map` and `filter`.
 
 ### Use `sort` to put files first
 
-Using this example, the explorer will alphabetically sort everything, but put all **files** above all **folders**.
+Using this example, the explorer will alphabetically sort everything.
 
 ```ts title="quartz.layout.ts"
 Component.Explorer({
   sortFn: (a, b) => {
-    if ((!a.file && !b.file) || (a.file && b.file)) {
+    return a.displayName.localeCompare(b.displayName)
-      return a.displayName.localeCompare(b.displayName)
-    }
-    if (a.file && !b.file) {
-      return -1
-    } else {
-      return 1
-    }
   },
 })
 ```
@@ -147,42 +130,47 @@ Using this example, the display names of all `FileNodes` (folders + files) will
 Component.Explorer({
   mapFn: (node) => {
     node.displayName = node.displayName.toUpperCase()
+    return node
   },
 })
 ```
 
 ### Remove list of elements (`filter`)
 
-Using this example, you can remove elements from your explorer by providing an array of folders/files using the `omit` set.
+Using this example, you can remove elements from your explorer by providing an array of folders/files to exclude.
+Note that this example filters on the title but you can also do it via slug or any other field available on `FileTrieNode`.
 
 ```ts title="quartz.layout.ts"
 Component.Explorer({
   filterFn: (node) => {
     // set containing names of everything you want to filter out
-    const omit = new Set(["authoring content", "tags", "hosting"])
+    const omit = new Set(["authoring content", "tags", "advanced"])
-    return !omit.has(node.name.toLowerCase())
+
+    // can also use node.slug or by anything on node.data
+    // note that node.data is only present for files that exist on disk
+    // (e.g. implicit folder nodes that have no associated index.md)
+    return !omit.has(node.displayName.toLowerCase())
   },
 })
 ```
 
-You can customize this by changing the entries of the `omit` set. Simply add all folder or file names you want to remove.
-
 ### Remove files by tag
 
-You can access the frontmatter of a file by `node.file?.frontmatter?`. This allows you to filter out files based on their frontmatter, for example by their tags.
+You can access the tags of a file by `node.data.tags`.
 
 ```ts title="quartz.layout.ts"
 Component.Explorer({
   filterFn: (node) => {
     // exclude files with the tag "explorerexclude"
-    return node.file?.frontmatter?.tags?.includes("explorerexclude") !== true
+    return node.data.tags?.includes("explorerexclude") !== true
   },
 })
 ```
 
 ### Show every element in explorer
 
-To override the default filter function that removes the `tags` folder from the explorer, you can set the filter function to `undefined`.
+By default, the explorer will filter out the `tags` folder.
+To override the default filter function, you can set the filter function to `undefined`.
 
 ```ts title="quartz.layout.ts"
 Component.Explorer({
@@ -194,10 +182,12 @@ Component.Explorer({
 
 > [!tip]
 > When writing more complicated functions, the `layout` file can start to look very cramped.
-> You can fix this by defining your functions in another file.
+> You can fix this by defining your sort functions outside of the component
+> and passing it in.
+>
+> ```ts title="quartz.layout.ts"
+> import { Options } from "./quartz/components/Explorer"
 >
-> ```ts title="functions.ts"
-> import { Options } from "./quartz/components/ExplorerNode"
 > export const mapFn: Options["mapFn"] = (node) => {
 >   // implement your function here
 > }
@@ -207,16 +197,12 @@ Component.Explorer({
 > export const sortFn: Options["sortFn"] = (a, b) => {
 >   // implement your function here
 > }
-> ```
 >
-> You can then import them like this:
->
-> ```ts title="quartz.layout.ts"
-> import { mapFn, filterFn, sortFn } from "./functions.ts"
 > Component.Explorer({
->   mapFn: mapFn,
+>   // ... your other options
->   filterFn: filterFn,
+>   mapFn,
->   sortFn: sortFn,
+>   filterFn,
+>   sortFn,
 > })
 > ```
 
@@ -227,93 +213,11 @@ To add emoji prefixes (📁 for folders, 📄 for files), you could use a map fu
 ```ts title="quartz.layout.ts"
 Component.Explorer({
   mapFn: (node) => {
-    // dont change name of root node
+    if (node.isFolder) {
-    if (node.depth > 0) {
+      node.displayName = "📁 " + node.displayName
-      // set emoji for file/folder
+    } else {
-      if (node.file) {
+      node.displayName = "📄 " + node.displayName
-        node.displayName = "📄 " + node.displayName
-      } else {
-        node.displayName = "📁 " + node.displayName
-      }
     }
   },
 })
 ```
-
-### Putting it all together
-
-In this example, we're going to customize the explorer by using functions from examples above to [[#Add emoji prefix | add emoji prefixes]], [[#remove-list-of-elements-filter| filter out some folders]] and [[#use-sort-to-put-files-first | sort with files above folders]].
-
-```ts title="quartz.layout.ts"
-Component.Explorer({
-  filterFn: sampleFilterFn,
-  mapFn: sampleMapFn,
-  sortFn: sampleSortFn,
-  order: ["filter", "sort", "map"],
-})
-```
-
-Notice how we customized the `order` array here. This is done because the default order applies the `sort` function last. While this normally works well, it would cause unintended behavior here, since we changed the first characters of all display names. In our example, `sort` would be applied based off the emoji prefix instead of the first _real_ character.
-
-To fix this, we just changed around the order and apply the `sort` function before changing the display names in the `map` function.
-
-### Use `sort` with pre-defined sort order
-
-Here's another example where a map containing file/folder names (as slugs) is used to define the sort order of the explorer in quartz. All files/folders that aren't listed inside of `nameOrderMap` will appear at the top of that folders hierarchy level.
-
-It's also worth mentioning, that the smaller the number set in `nameOrderMap`, the higher up the entry will be in the explorer. Incrementing every folder/file by 100, makes ordering files in their folders a lot easier. Lastly, this example still allows you to use a `mapFn` or frontmatter titles to change display names, as it uses slugs for `nameOrderMap` (which is unaffected by display name changes).
-
-```ts title="quartz.layout.ts"
-Component.Explorer({
-  sortFn: (a, b) => {
-    const nameOrderMap: Record<string, number> = {
-      "poetry-folder": 100,
-      "essay-folder": 200,
-      "research-paper-file": 201,
-      "dinosaur-fossils-file": 300,
-      "other-folder": 400,
-    }
-
-    let orderA = 0
-    let orderB = 0
-
-    if (a.file && a.file.slug) {
-      orderA = nameOrderMap[a.file.slug] || 0
-    } else if (a.name) {
-      orderA = nameOrderMap[a.name] || 0
-    }
-
-    if (b.file && b.file.slug) {
-      orderB = nameOrderMap[b.file.slug] || 0
-    } else if (b.name) {
-      orderB = nameOrderMap[b.name] || 0
-    }
-
-    return orderA - orderB
-  },
-})
-```
-
-For reference, this is how the quartz explorer window would look like with that example:
-
-```
-📖 Poetry Folder
-📑 Essay Folder
-    ⚗️ Research Paper File
-🦴 Dinosaur Fossils File
-🔮 Other Folder
-```
-
-And this is how the file structure would look like:
-
-```
-index.md
-poetry-folder
-    index.md
-essay-folder
-    index.md
-    research-paper-file.md
-dinosaur-fossils-file.md
-other-folder
-    index.md
-```

docs/features/folder and tag listings.md

@@ -30,4 +30,4 @@ As with folder listings, you can also provide a description and title for a tag
 
 ## Customization
 
-The folder listings are a functionality of the [[FolderPage]] plugin, the tag listings of the [[TagPage]] plugin. See the plugin pages for customization options.
+Quartz allows you to define a custom sort ordering for content on both page types. The folder listings are a functionality of the [[FolderPage]] plugin, the tag listings of the [[TagPage]] plugin. See the plugin pages for customization options.

docs/features/graph view.md

@@ -36,6 +36,7 @@ Component.Graph({
     opacityScale: 1, // how quickly do we fade out the labels when zooming out?
     removeTags: [], // what tags to remove from the graph
     showTags: true, // whether to show tags in the graph
+    enableRadial: false, // whether to constrain the graph, similar to Obsidian
   },
   globalGraph: {
     drag: true,
@@ -49,6 +50,7 @@ Component.Graph({
     opacityScale: 1,
     removeTags: [], // what tags to remove from the graph
     showTags: true, // whether to show tags in the graph
+    enableRadial: true, // whether to constrain the graph, similar to Obsidian
   },
 })
 ```

docs/features/private pages.md

@@ -13,9 +13,7 @@ There may be some notes you want to avoid publishing as a website. Quartz suppor
 If you'd like to only publish a select number of notes, you can instead use [[ExplicitPublish]] which will filter out all notes except for any that have `publish: true` in the frontmatter.
 
 > [!warning]
-> Regardless of the filter plugin used, **all non-markdown files will be emitted and available publically in the final build.** This includes files such as images, voice recordings, PDFs, etc. One way to prevent this and still be able to embed local images is to create a folder specifically for public media and add the following two patterns to the ignorePatterns array.
+> Regardless of the filter plugin used, **all non-markdown files will be emitted and available publically in the final build.** This includes files such as images, voice recordings, PDFs, etc.
->
-> `"!(PublicMedia)**/!(*.md)", "!(*.md)"`
 
 ## `ignorePatterns`
 
@@ -28,7 +26,7 @@ Common examples include:
 
 - `some/folder`: exclude the entire of `some/folder`
 - `*.md`: exclude all files with a `.md` extension
-- `!*.md` exclude all files that _don't_ have a `.md` extension
+- `!(*.md)` exclude all files that _don't_ have a `.md` extension. Note that negations _must_ parenthesize the rest of the pattern!
 - `**/private`: exclude any files or folders named `private` at any level of nesting
 
 > [!warning]

docs/features/reader mode.md

@@ -0,0 +1,44 @@
+---
+title: Reader Mode
+tags:
+  - component
+---
+
+Reader Mode is a feature that allows users to focus on the content by hiding the sidebars and other UI elements. When enabled, it provides a clean, distraction-free reading experience.
+
+## Configuration
+
+Reader Mode is enabled by default. To disable it, you can remove the component from your layout configuration in `quartz.layout.ts`:
+
+```ts
+// Remove or comment out this line
+Component.ReaderMode(),
+```
+
+## Usage
+
+The Reader Mode toggle appears as a button with a book icon. When clicked:
+
+- Sidebars are hidden
+- Hovering over the content area reveals the sidebars temporarily
+
+Unlike Dark Mode, Reader Mode state is not persisted between page reloads but is maintained during SPA navigation within the site.
+
+## Customization
+
+You can customize the appearance of Reader Mode through CSS variables and styles. The component uses the following classes:
+
+- `.readermode`: The toggle button
+- `.readerIcon`: The book icon
+- `[reader-mode="on"]`: Applied to the root element when Reader Mode is active
+
+Example customization in your custom CSS:
+
+```scss
+.readermode {
+  // Customize the button
+  svg {
+    stroke: var(--custom-color);
+  }
+}
+```

docs/features/social images.md

@@ -0,0 +1,19 @@
+---
+title: "Social Media Preview Cards"
+---
+
+A lot of social media platforms can display a rich preview for your website when sharing a link (most notably, a cover image, a title and a description).
+
+Quartz can also dynamically generate and use new cover images for every page to be used in link previews on social media for you.
+
+## Showcase
+
+After enabling the [[CustomOgImages]] emitter plugin, the social media link preview for [[authoring content | Authoring Content]] looks like this:
+
+| Light                               | Dark                               |
+| ----------------------------------- | ---------------------------------- |
+| ![[social-image-preview-light.png]] | ![[social-image-preview-dark.png]] |
+
+## Configuration
+
+This functionality is provided by the [[CustomOgImages]] plugin. See the plugin page for customization options.

docs/features/syntax highlighting.md

@@ -95,6 +95,16 @@ const [age, setAge] = useState(50)
 const [name, setName] = useState("Taylor")
 ```
 
+### Inline Highlighting
+
+Append {:lang} to the end of inline code to highlight it like a regular code block.
+
+```
+This is an array `[1, 2, 3]{:js}` of numbers 1 through 3.
+```
+
+This is an array `[1, 2, 3]{:js}` of numbers 1 through 3.
+
 ### Line numbers
 
 Syntax highlighting has line numbers configured automatically. If you want to start line numbers at a specific number, use `showLineNumbers{number}`:

docs/features/upcoming features.md

@@ -2,22 +2,11 @@
 draft: true
 ---
 
-## high priority backlog
-
-- static dead link detection
-- block links: https://help.obsidian.md/Linking+notes+and+files/Internal+links#Link+to+a+block+in+a+note
-- note/header/block transcludes: https://help.obsidian.md/Linking+notes+and+files/Embedding+files
-- docker support
-
 ## misc backlog
 
-- breadcrumbs component
+- static dead link detection
 - cursor chat extension
-- https://giscus.app/ extension
 - sidenotes? https://github.com/capnfabs/paperesque
 - direct match in search using double quotes
 - https://help.obsidian.md/Advanced+topics/Using+Obsidian+URI
-- audio/video embed styling
 - Canvas
-- parse all images in page: use this for page lists if applicable?
-- CV mode? with print stylesheet