Applying changes to the Wiki

The wiki is based on a shared Obsidian vault. Currently, the vault is published with forestry.md by piemet.

Only full QLight members, with access to the O-drive, can implement changes in the Wiki. If you wish to contribute but do not have permissions, contact one of us.

Applying changes with a text editor

  1. Make sure you have access to the group's O-drive. If you are using your work PC, this should be mounted among your Network drives. Otherwise, you can mount it by using your DTU credentials on this address: smb://ait-pqumulo.win.dtu.dk/elec$/ELEC/3438-NANO-QLIGHT. Make sure to add "win/" before your username initials.
  2. Navigate to the QLight wiki folder.
  3. Open the note you wish to edit in your text editor of choice, and save the file once you are happy with the changes.
  4. If you wish to create a new note, simply create a text file with a ".md" extension in the appropriate folder, and add
    --- dg-publish: true
    `---
    at the beginning of the file.

Applying changes with Obsidian

While not necessary, Obsidian makes it easier to visualize the entire Wiki.

  1. Download and install Obsidian from https://obsidian.md/, if you have not done so already.
  2. When prompted, choose "Open folder as vault" and navigate to the group's O-drive folder (following the instructions above)
  3. If prompted, choose "Trust this vault" to enable the plugins associated with this vault.
  4. You should now be able to visualize and edit the entire Wiki. To make a new note public, make sure to add
    --- dg-publish: true
    `---
    at the beginning of the file.

Formatting

Obsidian is markdown-based, so the file structure is simple. Some basic commands are given below:

Headers

# H1  – Page title (also used for top‑level sections)   
## H2 – Main sections   
### H3 – Sub‑sections   
#### H4 – Smaller subsections

Emphasis

Syntax Result
**bold** bold
*italic* italic
***bold + italic*** bold + italic
`inline code` inline code
~~strikethrough~~ strikethrough

Lists

Type Syntax Example
External URL [link text](https://example.com) [Proton Mail](https://proton.me/mail)
Internal (Obsidian) link [[Page Name]] [[Getting Started]]

Publishing changes

After editing the vault, changes are not automatically pushed to the static website. To do so, you must have Obsidian installed and configure the Digital Garden plugin by following this guide.

Beware that we only have 30 builds per month. Only publish your changes when you have finished editing.

  1. If you have not done so, install the Digital Garden plugin in Obsidian from the Community Plugins section and enable it ("Ctrl + ,", Community plugins).
  2. Navigate to the Digital Garden plugin settings in Obsidian.
  3. In the plugin settings, choose "Forestry.md" as your publishing platform.
  4. Copy the key found in the "key.md" file and paste it into the plugin settings, then click authorize.
  5. Use the "Publish All Notes Marked for Publish" command to publish your home page note (write this command after pressing Ctrl + P).