Steps to Contributing to the Wiki page:
- Go to https://obsidian.md/download and download + install obsidian
- Open Obsidian and create a new vault or open an existing one where you’ll store the wiki
- Go to https://desktop.github.com/download/ and download + install github
- Open GitHub and create an account
- Obtain the wiki repository URL on the Quill & Pigeon GitHub page
- Open GitHub Desktop and click on “File” and then “Clone Repository”. In the URL tab, paste the URL of the wiki repository. Chose a directory to clone the repository and click “clone”
- Open the cloned repository in Obsidian. Go to “File” and “Open Folder” as vault. Navigate from Github folder to Quill and Pigeon folder to Documentation folder to Quartz and open.
To Make Changes on the Wiki Page
- Make necessary changes on Obsidian. You can switch to preview mode to see how your changes will look. Remember to save your changes every so often as you go.
- Go to GitHub Desktop and you should be able to review your edits. Go to the “Changes” tab and review your modifications to ensure everything is correct
- Write a commit message summarizing your updates. If you’re ready to transfer these changes over to the wiki click “commit to main”.
- Click “push origin” to upload these changes to the remote repository.
references
https://quartz.jzhao.xyz/authoring-content great article on presentation as code using Obsidian: https://nicolevanderhoeven.com/blog/20210302-presentation-slides-as-code/