“[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/
👋 Welcome to the Course Notes repository! Listed below are points to follow in order to collaborate:
- Ask to join the organization on the Telegram group so that we can invite you, If you don't have a GitHub account, create one. If you wish to start collaborating immediately, star this project and follow the organization while waiting for the invitation.
- Download Obsidian.
- Download Github Desktop. This step is for those unfamiliar with git or uncertain about collaboration. For others, choose the software that suits you best for managing the repository.
- Clone this repository to your PC If you have installed github desktop after an authentication step, you will have the possibility to clone a repository, do it. Select "For my own purposes" when asked
-
For first-time contributors:
- Copy the
.obsidianfolder in theSharedObsidianSettingsinto thecontentdirectory to ensure correct Obsidian settings. Note that the folders starting with a "." might be hidden, pressCMD+SHIFT+.on Mac or selectView > Show > Hidden itemsin Windows.
- Copy the
-
Open Obsidian, select "Open folder as vault," and choose the
contentfolder inside the repository. If prompted, select "trust the author" to enable all plugins automatically.
-
Start editing and creating new files in Obsidian.
-
When finished, commit and push If you are using github desktop, open it
- Check your changes
-
- Commit with a meaningful message
-
- Push it to the reposiotry
-
When pushing changes, ensure you've pulled the latest updates to avoid conflicts, which may arise if multiple edits occur on the same file. To avoid this issue, regularly Obsidian automatically perform a pull on opening and closing.
Conflicts are displayed like this:
Use your preferred code editor, such as Visual Studio Code, to resolve conflicts:
Once you've decided on the changes to keep, use GitHub Desktop to push the updates.
🚀 We welcome contributions to improve these course notes! Follow our contribution guidelines to get started.
This project is licensed under the Attribution-NonCommercial-ShareAlike 4.0 International License - see the LICENSE.md file for details. This license prohibits commercial use without explicit permission from the copyright holder
