quartz README

The project's README from github.com/jackyzha0/quartz. As one markdown file: README.md.

Quartz v5

“[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming

Quartz is a set of tools that helps you publish your digital garden and notes as a website for free.

🔗 Read the documentation and get started: https://quartz.jzhao.xyz/

Join the Discord Community

Sponsors

quartz (jackyzha0/quartz)

Searching Database…

13.4K ·GitHub
Что это такое?Quartz — это генератор статических сайтов, который превращает заметки в формате Markdown в полноценный работающий сайт. Он создан специально для публикации цифровых садов и взаимосвязанных заметок.
Это самостоятельное приложение или инструмент, который я запускаю для своих заметок?Это генератор статических сайтов, который работает через командную строку: вы запускаете его команду сборки для папки с файлами Markdown (часто это хранилище Obsidian), и на выходе получается сайт, который можно опубликовать.
Как запустить сайт с помощью Quartz?Инициализируйте проект через CLI Quartz (./quartz/bootstrap-cli.mjs), а затем соберите и запустите сайт локально командой вроде 'npx quartz build --serve', указав папку с вашим содержимым в Markdown.
Что нужно установить перед тем, как пробовать Quartz?Нужны Node.js 22+ и npm 10.9.2+; Python, Go или Rust не требуются.
Работает ли он с любыми заметками в Markdown или только с хранилищами Obsidian?Он ориентирован на диалект Markdown, используемый в Obsidian (в темах репозитория прямо упомянуты obsidian и obsidian-md), поэтому лучше всего работает с заметками в этом стиле, хотя обычный Markdown тоже поддерживается.
Можно ли разместить готовый сайт где угодно или Quartz требует определённый хостинг?В README хостинг подробно не описан, но так как на выходе получается статический сайт, его можно развернуть на любом статическом хостинге (например, GitHub Pages, Netlify, Cloudflare Pages).
Поддерживает ли Quartz систему плагинов?Да, в нём есть экосистема устанавливаемых плагинов. Об этом говорят сообщественные плагины, такие как backlinks, breadcrumbs, citations и рендерер страниц canvas, перечисленные в его зависимостях.
Что означает «networked thought» применительно к этому инструменту?Это означает, что Quartz делает упор на сохранение связей между заметками (например, обратных ссылок и связей между статьями), чтобы опубликованный сайт отражал взаимосвязанную структуру вашей базы знаний, а не просто набор отдельных страниц.
Есть ли вариант запуска Quartz в Docker?Да, в репозитории есть поддержка Docker и отдельный CI-процесс docker-build-push для сборки и публикации Docker-образа.
Creator
jackyzha0
Size
39.1 MB
Stars
13.4K
Age
5y
Commits · 90 Days