Merge pull request #16 from imfenghuang/patch-1

docs: update README.md
This commit is contained in:
NOCanoa 2024-08-24 15:30:04 +00:00 committed by GitHub
commit 7204d076d2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,18 +1,15 @@
# Quartz v4
# [docs.zen-browser.app](https://docs.zen-browser.app)
> “[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
Welcome to **Zen Browsers Documentation!**
Quartz is a set of tools that helps you publish your [digital garden](https://jzhao.xyz/posts/networked-thought) and notes as a website for free.
Quartz v4 features a from-the-ground rewrite focusing on end-user extensibility and ease-of-use.
## Contributing
🔗 Read the documentation and get started: https://quartz.jzhao.xyz/
This site is built with [Quartz 4.0](https://quartz.jzhao.xyz/). Site content is written in Markdown format located in `content`.
[Join the Discord Community](https://discord.gg/cRFFHYye7t)
For local preivew:
## Sponsors
<p align="center">
<a href="https://github.com/sponsors/jackyzha0">
<img src="https://cdn.jsdelivr.net/gh/jackyzha0/jackyzha0/sponsorkit/sponsors.svg" />
</a>
</p>
```bash
npm i
# for preview
npm run docs
```