quartz/docs
Anton Bulakh 8651f887d9
feat: untangle quartz from local configs in least amount of changes
For the current setup where people have to fork or at least clone quartz
this changes nothing - but it allows you to install quartz as a
devDependency via npm and have it actually work.

One real change is switch from `.quartz-cache` to
`node_modules/.cache/quartz` for transpilation results, this is an
artifact from my previous attempts, I guess with this one I can change
it back - but `node_modules/.cache` feels more better imo idk.

edit: OTOH if you want to have quartz be a _completely_ separate binary
(which this also enables I think), having it create a node_modules
folder is weird, so I made a quick hack for that for now.

Example:
```bash
$ mkdir my-repo && cd my-repo
$ npm i quartz@necauqua/quartz#untangled # quartz@ prefix is important
$ cp node_modules/quartz/quartz.*.ts .   # copy the default configs
$ mkdir content && echo "# Hello World!" > content/index.md
$ npx quartz build --serve # this just works!
$ echo 'body { background: red !important; }' > styles.scss
```
Notice how I used my branch in the `npm i` line, ideally it'd be
`npm i quartz@jackyzho0/quartz`, or maybe we can somehow get the quartz
package on npm and it'll just be `npm i quartz`.
In the latter case `npx quartz build` will literally just work without
a local npm package at all?.

Having some support for components and plugins being in separate npm
packages instead of people copying code around is not out of the picture
with this too btw.

Closes #502

MOVE ME
2025-02-14 03:01:10 +02:00
..
advanced feat: untangle quartz from local configs in least amount of changes 2025-02-14 03:01:10 +02:00
features feat(graph): enable radial mode (#1738) 2025-02-01 16:22:29 -05:00
images feat(open-graph): generate OG images + further OG support (#740) 2024-11-12 07:33:35 -05:00
plugins Fix ObsidianFlavoredMarkdown source link (#1694) 2024-12-30 08:03:57 -08:00
tags docs: update plugin documentation (#888) 2024-02-23 12:07:53 -08:00
authoring content.md docs: added permalink description to supported frontmatter doc (#1369) 2024-08-23 18:35:52 -07:00
build.md docs: clarify prod hosting 2024-09-15 16:47:11 -07:00
configuration.md feat(analytics): clarity (#1446) 2024-09-30 10:06:37 -07:00
hosting.md docs(hosting): add apache config example (#1608) 2024-11-20 19:29:43 -05:00
index.md deps: change min required nodejs to v20 (breaking) 2024-08-05 18:41:46 -07:00
layout.md feat: responsive design grid (#1354) 2024-09-23 13:40:12 -07:00
migrating from Quartz 3.md Fix #403 by moving documentation to separate directory to avoid merge conflicts (#405) 2023-08-23 12:09:04 -07:00
philosophy.md docs: agentic computing in quartz philosophy 2023-12-17 13:01:44 -08:00
setting up your GitHub repository.md docs: improve first-time git setup 2024-01-28 00:20:08 -08:00
showcase.md docs(showcase): 8cat.life (#1617) 2024-12-03 01:50:50 -05:00
upgrading.md Fix #403 by moving documentation to separate directory to avoid merge conflicts (#405) 2023-08-23 12:09:04 -07:00