diff --git a/GEMLOG.md b/GEMLOG.md new file mode 100644 index 0000000..76f234c --- /dev/null +++ b/GEMLOG.md @@ -0,0 +1,44 @@ +# Gemlog Style Guide + +## File Naming +All files should be named as the date (YYYY-MM-DD)) and title with - replacing the spaces. + +### Why +This allows proper sorting while also being able to quickly see what content is in the file. + +### Example +``` +2020-04-22-My-First-Gemlog.gmi +``` + +## Title +All gemlogs should contain a title denoted by a single `#` with one whitespace afterwards, then the title. + +### Why +Besides # denoting h1, which is common for titles, the single space afterwards looks nice if the gemini client does not render the #. + +### Example +``` +# My First Gemlog +``` + +## Sections +Sections should be denoted by two `#` which corresponds to h2 with white space above and no whitespace below. + +### Why +Sectioning posts keeps things nice and tidy, while using h2 keeps the content broken separated well without needing unnecessary whitespace. + +### Example +``` +... +Here is some content for the previous section + +## Foo Section +Here is the first sentence of the Foo Section +``` + +## Links +TODO + +## Navigation +TODO