This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
| title | date | author | id | keywords | |
|---|---|---|---|---|---|
| Style Guide | 2026-07-14 13:34 | Lee Kierstead | 1784057685 |
|
This a set of guidelines for formatting of the notes to ensure compatibility and to try future-proof things.
Directory Structure
Files are not nested in any folders in order for linking to work in git wikis using a simple link syntax (see Link Format below), in other words it’s a flat file structure.
File Contents
Everything related to the contents of the files.
File Metadata
Is written using YAML headers and include the following keys at minimum:
- title
- date
- author
- id
- keywords
Title
The title should assist in summarizing or be a cue on what the note is about.
Date
The date field is an alternative timestamped format the same as the file name (see File Naming and Format) except using YYYY-MM-DD HH:MM.
Author
This should be the first and last name of whoever wrote the note.
ID
A unique identifier which serves as a backup in a sense as the filename itself should be unique enough. These are based on a Unix Timestamp.
Keywords
This is an alternative to inline tags (using hashes, see Inline Tags), one word to help relate to other notes. If many keywords are used, it should be in a single-square bracket array seperated by commas.
General Guidelines
Careful attention should be given towards note length. Notes should be atomicized so they represent one idea and be heavily linked to any related ideas. This is based on modern digital Zettlekasten principles.
Inline Tags
Tags should be below the main body of the text and above the See Also links (see See Also Section) indicated by a single word with a hash in front (no spaces), if multiworded separated with a hyphen.
Link Format
Links are done in a wiki-link type syntax using square brackets rather than markdown links, and have the title or inline aliases set first before the file.
Example: [[Active Directory|202501101423]]
See Also (Section)
At the bottom of any new notes should be a link back to a previous thought that lead to the note if applicable and/or related notes. This should be separated from the rest of the note with a horizontal line or three asterisk characters.
Text Formatting
Based on the most broadly available markdown formatting characters. Such as _ for italicizing, ** for bolding. Check the Commonmark guide as a reference.
File Naming and Format
Notes are created with a dated format of YYYYMMDDHHMM and are written as markdown with the extension md. These should be auto-named based on the time of creation.