Tips Obsidian icm GitHub wiki

Voorbereiden van Obsidian icm Git

Eerst moet je via de terminal de repo lokaal binnenhalen met git clone.

In de repo staat een git-ignore-bestand. Zorg dat je dubbelcheckt of je die daadwerkelijk heb binnengehaald. (zie ook gitignore)

# macOS system files
.DS_Store
.AppleDouble
.LSOverride
.Spotlight-V100
.Trashes
__MACOSX/

# ignore local-only files in this folder
/LOCAL-ONLY/

# Obsidian editor config
.obsidian/
.obsidian/workspace.json
.obsidian/core-plugins.json

# VS Code workspace settings
.vscode/

# Temporary or backup files
*.swp
*.swo
*.tmp
*~

# Windows system files
Thumbs.db
ehthumbs.db
Desktop.ini

# Windows hidden folders (optional)
$RECYCLE.BIN/
System Volume Information/

# Windows backup and temporary files
*.bak
*.tmp
*.log

# Windows-specific Git lock files
*.lock

Remote repo configureren in Git

git remote set-url origin git@github.com:ICTU/security-tooling-reference.wiki

Configuratie van Obsidian

1. Installeer de community plug-in GIT.

2. Wijzig onderstaande instellingen in Obsidian

1. Ga in de Obsidian-instellingen naar ‘Bestanden en links’ onder ‘Opties’ en wijzig de instelling ‘nieuw linkformaat’ in ‘absoluut pad in vault’.

2. Schakel in hetzelfde venster de instelling ‘wikilinks gebruiken’ uit.

GitHub kan gebruikmaken van de standaard markdown-links, waardoor de ! wordt verwijderd. Wanneer u deze instelling gebruikt met absolute paden, lijkt het ontbreken van een schuine streep in het pad geen probleem te zijn.

3. Afbeeldingenmap

GitHub Flavoured MarkDown Tips

De GitHub-wiki werkt met een bijzondere versie van MarkDown namelijk GFM (GitHub Flavoured MarkDown). Hieronder staan wat tips over het gebruik van bepaalde elementen zodat ze werken op zowel de GitHub-wiki als in Obsidian.

Links

[linktekst](/uri#fragment-identifier "titel")

<p><a href="/uri#fragment-identifier" title="titel">linktekst</a></p>

Zie ook

https://github.github.com/gfm/#links

Interne Links

Let op: voor het maken van een correcte interne link (dus naar andere pagina's op dezelfde wiki) die werkt in ZOWEL GitHub-wiki als Obsidian een link aan onderstaande voorwaarden voldoen:

• spaties zijn vervangen door %20 of -. → voorkeur voor - ivm leesbaarheid
• hoofdletters → blijven meestal behouden (maar het is verstandig om de exacte paginatitel te checken)
• speciale tekens (zoals ?, ,, /) → vaak verwijderd of omgezet → bij voorkeur speciale tekens vermijden omdat het dan niet werkt in Obsidian!
• geen slash aan het begin van het adres
• geen extensie (zoals .md op het eind)
• de #fragment-identifier is altijd met kleine letters en de spaties zijn altijd hyphens

Voorbeeld

[Voorbeeld-link naar deze pagina](Tips-Obsidian-icm-GitHub-wiki#interne-links "Klik hier om het voorbeeld uit te proberen.")

Resultaat

Voorbeeld-link naar deze pagina

Link-reference-definitie

Het gebruik van link reference definitions in Markdown (zoals gedefinieerd in de GitHub Flavored Markdown specificatie) heeft vooral voordelen voor leesbaarheid en onderhoudbaarheid van je tekst. Het gebruik van LRD wordt geadviseerd maar werkt helaas niet als men #fragments wil gebruiken.

Voorbeeld

[link-referentie]: Tips-Obsidian-icm-GitHub-wiki "Klik hier om het voorbeeld uit te proberen."

[link-referentie]

Resultaat

link-referentie

Zie ook

https://github.github.com/gfm/#link-reference-definitions

Afbeeldingen

Voorbeeld

![foo](/url "title")

<p><img src="/url" alt="foo" title="title" /></p>

Resultaat

Meer informatie

https://github.github.com/gfm/

https://help.obsidian.md/obsidian-flavored-markdown

https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis