gravityfargo/modernleft-docs
1
0
Fork 0
Code Issues 1 Activity

vault backup: 2025-01-17 11:51:51

Browse source
This commit is contained in:
Nathan Price 2025-01-17 11:51:51 -05:00
parent d87f05b698
commit 5f7057ce22
Signed by: gravityfargo
SSH key fingerprint: SHA256:bjq+uA1U+9bFMd70q2wdNtwaYxGv84IBXalnYvZDKmg
1 changed files with 4 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
Applications/quartz-docker.md
View file

@ -12,7 +12,7 @@ docker pull code.modernleft.org/gravityfargo/quartz-docker:v4.4.0
This project runs **Quartz 4**, a fast, batteries-included static site generator, inside a **Docker container**. It transforms Markdown content into a fully functional website. This project runs **Quartz 4**, a fast, batteries-included static site generator, inside a **Docker container**. It transforms Markdown content into a fully functional website.
While Quartz provides [Docker support](https://quartz.jzhao.xyz/features/Docker-Support), it requires additional configuration. This container simplifies the process. While Quartz provides [Docker support](https://quartz.jzhao.xyz/features/Docker-Support), it requires additional configuration. This container simplifies the process significantly.
## 🚀 Features ## 🚀 Features
@ -24,8 +24,6 @@ While Quartz provides [Docker support](https://quartz.jzhao.xyz/features/Docker-
### 🐳 Docker Compose ### 🐳 Docker Compose
See a list of all environment variables [here](#environment-variables).
1. Create a data directory and pull your existing content: 1. Create a data directory and pull your existing content:
```bash ```bash
@ -52,12 +50,6 @@ See a list of all environment variables [here](#environment-variables).
##### `BASE_URL` ##### `BASE_URL`
The only required variable is `BASE_URL`. This sets both Quartz's `baseUrl` and Nginx's `server_name`. The only required variable is `BASE_URL`. This sets both Quartz's `baseUrl` and Nginx's `server_name`.
Example:
```yaml
environment:
- BASE_URL=https://example.com
```
#### Recommended Setup #### Recommended Setup
@ -85,7 +77,7 @@ See a list of all environment variables [here](#environment-variables).
##### Enabling Cron Jobs ##### Enabling Cron Jobs
Setting `ENABLE_CRON` to `true` and defining `BUILD_SCHEDULE` as a cron expression allows `npx quartz build` to run on a schedule, ensuring your site remains updated with the latest content. Setting `ENABLE_CRON` to `true` and defining `BUILD_SCHEDULE` as a cron expression allows `npx quartz build` to run on a schedule. That command pulls the latest content and rebuilds the site.
Example: Example:
@ -97,6 +89,8 @@ See a list of all environment variables [here](#environment-variables).
## 📌 Environment Variables ## 📌 Environment Variables
See a list of all environment variables [here](#environment-variables).
| Variable | Description | Default Value | | Variable | Description | Default Value |
| ---------------- | -------------------------------------------- | ------------------------------- | | ---------------- | -------------------------------------------- | ------------------------------- |
| `BASE_URL` | The base URL for the site (Required) | None | | `BASE_URL` | The base URL for the site (Required) | None |