mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-23 22:45:41 -05:00
🌱 a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites
8651f887d9
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
|
||
|---|---|---|
| .github | ||
| content | ||
| docs | ||
| quartz | ||
| .gitattributes | ||
| .gitignore | ||
| .node-version | ||
| .npmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| ambient.d.ts | ||
| CODE_OF_CONDUCT.md | ||
| Dockerfile | ||
| globals.d.ts | ||
| index.ts | ||
| LICENSE.txt | ||
| package-lock.json | ||
| package.json | ||
| quartz.config.ts | ||
| quartz.layout.ts | ||
| README.md | ||
| tsconfig.json | ||
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/
Sponsors
