“One who works with the door open gets all kinds of interruptions, but they also occasionally get clues as to what the world is and what might be important.”
— Richard Hamming
This project is a fork of the Quartz project, with adjustments to the default configuration to streamline the rollout of documentation projects for ForgeFX.
To get started, follow these steps:
- Install Dependencies: Open your terminal and run the following commands:
npm i
npx quartz createIf you encounter errors during the install or setup steps, it may indicate missing packages on your system. Install the necessary packages and continue.
Pro Tip: Sending screenshots of errors to ChatGPT is an easy and efficient way to troubleshoot issues.
- Local Development: To test the build locally, use the following command:
npx quartz build --serveThe deployment process is already set up for you. The deploy.yml workflow file has been added to the .github/workflows/ directory of the project. To finalize the deployment:
- Navigate to the Settings tab of your forked repository.
- In the sidebar, click Pages.
- Under Source, select GitHub Actions for deployment.
Once enabled, your website will automatically update with each commit to the repository. Please note, updates may take a few minutes to appear. You can track the progress from the Deployments tab on the repository’s home page.
To customize the page's metadata, you can modify the quartz.config.ts file located in the project root. Detailed documentation for configuring Quartz can be found here.
The easiest way to create and manage content is to use Obsidian. Simply open the content folder of this project as a vault in Obsidian. Alternatively, you can directly edit the markdown files or use another editor like Cursor IDE.
- Quartz 4 Documentation: https://quartz.jzhao.xyz/