quartz
π± a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- build-preview.yaml
- ci.yaml
- deploy-preview.yaml
- deploy-v5.yaml
- docker-build-push.yaml
- dependabot.yml
- FUNDING.yml
- pull_request_template.md
- .gitkeep
- architecture.md
- creating components.md
- index.md
- making plugins.md
- paths.md
- build.md
- create.md
- index.md
- plugin.md
- restore.md
- sync.md
- tui.md
- upgrade.md
- backlinks.md
- Bases.md
- breadcrumbs.md
- callouts.md
- Canvas.md
- Citations.md
- comments.md
- darkmode.md
- Docker Support.md
- explorer.md
- folder and tag listings.md
- full-text search.md
- graph view.md
- i18n.md
- index.md
- Latex.md
- Mermaid diagrams.md
- Obsidian compatibility.md
- OxHugo compatibility.md
- popover previews.md
- private pages.md
- reader mode.md
- recent notes.md
- Roam Research compatibility.md
- RSS Feed.md
- social images.md
- SPA Routing.md
- syntax highlighting.md
- table of contents.md
- wikilinks.md
- authoring-content.md
- index.md
- installation.md
- migrating.md
- upgrading.md
- whats-new.md
- custom-social-image-preview-dark.png
- custom-social-image-preview-light.png
- dns records.png
- giscus-discussion.png
- giscus-example.png
- giscus-repo.png
- giscus-results.png
- github-init-repo-options.png
- github-quick-setup.png
- quartz transform pipeline.png
- quartz-layout-desktop.png
- quartz-layout-mobile.png
- quartz-layout-tablet.png
- social-image-preview-dark.png
- social-image-preview-light.png
- AliasRedirects.md
- ArticleTitle.md
- Assets.md
- Backlinks.md
- BasesPage.md
- Breadcrumbs.md
- CanvasPage.md
- Citations.md
- CNAME.md
- Comments.md
- ComponentResources.md
- ContentIndex.md
- ContentMeta.md
- ContentPage.md
- CrawlLinks.md
- CreatedModifiedDate.md
- CustomOgImages.md
- Darkmode.md
- Description.md
- EncryptedPages Demo.md
- EncryptedPages.md
- ExplicitPublish.md
- Explorer.md
- Favicon.md
- FolderPage.md
- Fonts.md
- Footer.md
- Frontmatter.md
- GitHubFlavoredMarkdown.md
- Graph.md
- HardLineBreaks.md
- index.md
- Latex.md
- NoteProperties.md
- NotFoundPage.md
- ObsidianFlavoredMarkdown.md
- OxHugoFlavoredMarkdown.md
- PageTitle.md
- ReaderMode.md
- RecentNotes.md
- RemoveDrafts.md
- RoamFlavoredMarkdown.md
- Search.md
- Spacer.md
- StackedPages.md
- Static.md
- SyntaxHighlighting.md
- TableOfContents.md
- TagList.md
- TagPage.md
- UnlistedPages.md
- component.md
- plugin.md
- Base.base
- Canvas.canvas
- community.md
- configuration.md
- hosting.md
- index.md
- layout-components.md
- layout.md
- philosophy.md
- showcase.md
- troubleshooting.md
- blog.yaml
- default.yaml
- obsidian.yaml
- ttrpg.yaml
- args.js
- constants.js
- handlers.js
- helpers.js
- helpers.test.js
- plugin-data.js
- plugin-git-handlers.js
- DefaultFrame.tsx
- frames.test.ts
- FullWidthFrame.tsx
- index.ts
- MinimalFrame.tsx
- registry.ts
- types.ts
- 404.tsx
- popover.inline.ts
- popover.test.ts
- search.test.ts
- spa.inline.ts
- util.ts
- popover.scss
- Body.tsx
- ConditionalRender.tsx
- Date.tsx
- DesktopOnly.tsx
- external.ts
- Flex.tsx
- Head.tsx
- Header.tsx
- index.ts
- MobileOnly.tsx
- PageList.tsx
- registry.test.ts
- registry.ts
- renderPage.test.ts
- renderPage.tsx
- Spacer.tsx
- types.ts
- ar-SA.ts
- ca-ES.ts
- cs-CZ.ts
- de-DE.ts
- definition.ts
- en-GB.ts
- en-US.ts
- es-ES.ts
- fa-IR.ts
- fi-FI.ts
- fr-FR.ts
- he-IL.ts
- hu-HU.ts
- id-ID.ts
- it-IT.ts
- ja-JP.ts
- kk-KZ.ts
- ko-KR.ts
- lt-LT.ts
- nb-NO.ts
- nl-NL.ts
- pl-PL.ts
- pt-BR.ts
- ro-RO.ts
- ru-RU.ts
- th-TH.ts
- tr-TR.ts
- uk-UA.ts
- vi-VN.ts
- zh-CN.ts
- zh-TW.ts
- index.ts
- assets.ts
- componentResources.ts
- helpers.ts
- index.ts
- static.ts
- index.ts
- componentLoader.ts
- conditions.ts
- config-loader.test.ts
- config-loader.ts
- frameLoader.ts
- gitLoader.ts
- index.ts
- install-plugins.ts
- loader.ts
- types.ts
- 404.ts
- dispatcher.test.ts
- dispatcher.ts
- index.ts
- matchers.ts
- index.ts
- config.ts
- index.ts
- quartz-plugins.schema.json
- types.ts
- vfile.ts
- emit.ts
- filter.ts
- parse.ts
- dark.css
- light.css
- icon.png
- og-image.png
- base.scss
- callouts.scss
- custom.scss
- syntax.scss
- variables.scss
- clone.ts
- ctx.ts
- emoji.ts
- emojimap.json
- escape.ts
- fileTrie.test.ts
- fileTrie.ts
- glob.ts
- jsx.tsx
- lang.ts
- log.ts
- path.test.ts
- path.ts
- perf.ts
- random.ts
- resources.tsx
- slugCollisions.test.ts
- slugCollisions.ts
- sourcemap.ts
- theme.ts
- trace.ts
- bootstrap-cli.mjs
- bootstrap-worker.mjs
- build.ts
- cfg.ts
- worker.ts
- .gitattributes
- .gitignore
- .node-version
- .npmrc
- .prettierignore
- .prettierrc
- CODE_OF_CONDUCT.md
- Dockerfile
- globals.d.ts
- index.d.ts
- LICENSE.txt
- package-lock.json
- package.json
- quartz.config.default.yaml
- quartz.ts
- README.md
- tsconfig.json
# Installation Guide
1. Get the code
git clone https://github.com/jackyzha0/quartz
Downloads the entire project code from GitHub to your computer.
cd quartz
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t quartz .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 quartz
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation
Was this content helpful?
(0 ratings)