Skip to content

Instantly share code, notes, and snippets.

@zudsniper
Last active April 18, 2023 04:31
Show Gist options
  • Save zudsniper/09e49a65818f4266989a5bccde07582a to your computer and use it in GitHub Desktop.
Save zudsniper/09e49a65818f4266989a5bccde07582a to your computer and use it in GitHub Desktop.
Markdown Memoir -- A primer of helpful tools and techniques I've learned when playing with the class of "Markdown" formatting languages -- or as the community refers to them, the Markdown Flavors.

MARKDOWN $MEMOIR$

markdown author  - zudsniper

INTRODUCTION

Should you somehow have both avoided the concept of "Markdown formatting" AND made it to this gist, this will serve as a launch point from which you can learn the syntax & the concepts behind them.


A list of all Markdown Flavors can be found here.1

A glossary of the various major Markdown flavors must be maintained, as knowing of their existence, and more importantly in which ways they differ, is instrumental to becoming proficient with the text markup language.

'My Forte'

It is in & for these two target flavors you will see me working most frequently.

  • GitHub the formatter of the text you're currently reading, on which I can use this type of text, somewhat uniquely.
  • Discord Also see this cheatsheet which is maintained as a good ol' gist.

'Pseudo Markdown'

This is how I refer to something like the notion23 of "Notion Markdown", which itself sits somewhere between the verbosity of a full-on webpage with HTML, CSS, and JavaScript and the quick, simple format which is the core of the Markdown philosophy.4

  • Notion a formatting which supports markdown input & output, but which does not exist as a Markdown document.

ASSORTED SNIPPETS

I decided that -- due to the fact that I'm already like 3 or 4 new nested tasks deep into the ADHD rabbit hole_5 -- I would start simply placing other snippets I've written which I feel provide helpful resources in their original (still overly formatted) formats, without stripping and fixing the context. This will obviously cost some readability... but I believe in you.


Helper Snippet from My Fork of @tf2-software-enthusiasts/awesome-tf2-devs (unfinished)

Howdy! I'm zod & I'm glad you're interested in contributing! Here are some helpful resources.

Button Generator (based on shields.io)
Emojiterra.com
Fontmeme TF2 Fonts
I also like to use images, but size is always an issue with that. You have two viable options...

  1. Drag & drop the image into this file in the online editor. Preview the page, and use CTRL + SHIFT + C to open the Developer Console. Select your image, and copy the element itself. Switch back to the editing tab of your markdown. Paste the HTML **& specify length and height via the old HTML way
  2. Use a tool like imagemagick/convert to generate a smaller image out of your big image! Example below:
$ convert <image1>.png -resize 40% <image1_out>.png  

Either way its much harder than it needs to be.
$FIN$

Footnotes

  1. A glossary of known Markdown flavors in the comfortable format of a gist.

  2. Footnotes on GitHub Information, StackOverflow (which has the right syntax but rather hilariously insists that it does not work in github gists.)

  3. I swear this wasn't on purpose.

  4. Adding this footnote because it might fool someone into believing there is any modicum of legitimacy to the term I just made up and flagrantly used here.

  5. each layer, as usual, more esoteric and unnecessary than the last. Like this footnote.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment