GitHub/quartz
1
0
Fork 2
mirror of https://github.com/jackyzha0/quartz.git synced 2025-12-19 10:54:06 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity
🌱 a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites
1,605 Commits 20 Branches 23 Tags 2.7 GiB
TypeScript 84.9%
SCSS 8.4%
JavaScript 4.8%
CSS 1.8%
2b63a094fe
Go to file
Copilot 2b63a094fe
docs: complete plugin decoupling with @plugin annotations (#7) 
* Initial plan

* Initial analysis and plan for decoupling completion

Co-authored-by: saberzero1 <8161064+saberzero1@users.noreply.github.com>

* docs: add @plugin annotations to transformers missing documentation

Co-authored-by: saberzero1 <8161064+saberzero1@users.noreply.github.com>

* docs: mark decoupling phases and success criteria as complete

Co-authored-by: saberzero1 <8161064+saberzero1@users.noreply.github.com>

* fix: move @plugin annotation in roam.ts to correct location

Move the @plugin documentation block to immediately precede the
RoamFlavoredMarkdown export, consistent with other transformer files
(gfm.ts, syntax.ts, linebreaks.ts). Previously it was placed before
the regex constant declarations.

Co-authored-by: saberzero1 <8161064+saberzero1@users.noreply.github.com>

* Changes before error encountered

Co-authored-by: saberzero1 <8161064+saberzero1@users.noreply.github.com>

* refactor: move documentation files from docs/ to project root

Move IMPLEMENTATION_SUMMARY.md, PLUGIN_MIGRATION.md, and SECURITY_SUMMARY.md
from docs/ directory to project root to keep them separate from user-facing
documentation.

Co-authored-by: saberzero1 <8161064+saberzero1@users.noreply.github.com>

* config: add implementation docs to ignore patterns

Add IMPLEMENTATION_SUMMARY.md, PLUGIN_MIGRATION.md, and SECURITY_SUMMARY.md
to ignorePatterns in quartz.config.ts to exclude them from the documentation
build. These files are implementation documentation for the project itself,
not user-facing documentation.

Co-authored-by: saberzero1 <8161064+saberzero1@users.noreply.github.com>

* chore: remove build output directories from git tracking

Remove public-current and public-v4 directories that were accidentally
committed during build testing. These directories are already covered by
.gitignore and should not be tracked in the repository.

Co-authored-by: saberzero1 <8161064+saberzero1@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: saberzero1 <8161064+saberzero1@users.noreply.github.com>
2025-11-17 02:02:41 +01:00
.github chore(deps): bump the ci-dependencies group across 1 directory with 5 updates (#2178) 2025-10-27 14:28:47 -07:00
content re-add gitkeep to content 2023-12-11 15:34:21 -08:00
docs docs: complete plugin decoupling with @plugin annotations (#7) 2025-11-17 02:02:41 +01:00
quartz docs: complete plugin decoupling with @plugin annotations (#7) 2025-11-17 02:02:41 +01:00
.gitattributes add gitattributes for windows 2023-08-02 20:59:56 -07:00
.gitignore feat: support configurable ws port and remote development (#429) 2023-08-27 17:39:42 -07:00
.node-version Node 22 (#1997) 2025-05-28 16:20:59 -07:00
.npmrc add engines field 2023-08-20 08:57:56 -07:00
.prettierignore fix notes 2023-08-07 23:57:24 -07:00
.prettierrc Use semi: false for prettier config 2022-05-02 08:57:25 -07:00
CODE_OF_CONDUCT.md run prettier 2023-07-22 17:27:41 -07:00
DESIGN_DOCUMENT_DECOUPLING.md docs: complete plugin decoupling with @plugin annotations (#7) 2025-11-17 02:02:41 +01:00
Dockerfile fix(docker): instructions + bump deps + bind mount (#1809) 2025-03-06 10:01:25 -08:00
globals.d.ts refactor(comments): move script to files (#1308) 2024-08-05 15:17:11 -04:00
IMPLEMENTATION_SUMMARY.md docs: complete plugin decoupling with @plugin annotations (#7) 2025-11-17 02:02:41 +01:00
index.d.ts feat: reader mode 2025-04-17 19:45:17 -07:00
LICENSE.txt add base structure 2021-07-18 09:35:42 -04:00
package-lock.json chore(deps): bump the production-dependencies group with 3 updates (#2190) 2025-11-06 09:05:21 -05:00
package.json chore(deps): bump the production-dependencies group with 3 updates (#2190) 2025-11-06 09:05:21 -05:00
PLUGIN_MIGRATION.md docs: complete plugin decoupling with @plugin annotations (#7) 2025-11-17 02:02:41 +01:00
quartz.config.ts docs: complete plugin decoupling with @plugin annotations (#7) 2025-11-17 02:02:41 +01:00
quartz.layout.ts feat: reader mode 2025-04-17 19:45:17 -07:00
README.md fix: remove quartz 3 references, update font style in popovers 2024-01-21 12:39:20 -08:00
SECURITY_SUMMARY.md docs: complete plugin decoupling with @plugin annotations (#7) 2025-11-17 02:02:41 +01:00
tsconfig.json perf: incremental rebuild (--fastRebuild v2 but default) (#1841) 2025-03-16 14:17:31 -07:00

README.md

Quartz v4

“[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. Quartz v4 features a from-the-ground rewrite focusing on end-user extensibility and ease-of-use.

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

Join the Discord Community

Sponsors