Denis Churilov potat-dev

Markdown Guide

Basic Markdown Formatting

Headings

# This is an <h1> tag

This is an tag

Using `<details>` in GitHub

Suppose you're opening an issue and there's a lot noisey logs that may be useful.

Rather than wrecking readability, wrap it in a <details> tag!

<details>
 Summary Goes Here

Update: As of 11 January 2022, git.io no longer accepts new URLs.

Command:

curl https://git.io/ -i -F "url=https://github.com/YOUR_GITHUB_URL" -F "code=YOUR_CUSTOM_NAME"

URLs that can be created is from:

https://github.com/*
https://*.github.com

Advanced Formatting in GitHub Markdown

GitHub Flavored Markdown lets you create useful documents in GitHub and GitHub Enterprise using .md files. Like other varieties of markdown, GitHub Markdown tries to be as readable as possible in its raw form, resulting in an intentionally limited set of formatting options. However, these options can feel restrictive when dealing with complex content.

Although GitHub Markdown strips out most HTML tags, here are a few tricks that can give you more flexibility when formatting your documents. These advanced formatting options can make your documents more useable, but they come at the expense of plain text readability, so use with caution.

Repository

What Will I Learn?

In general, you will learn some markdown tricks combined with standard HTML tags. In more details what you will learn:

Hide-show content
Writing codeblocks inside codeblocks
Combining and using italic, bold, superscript, subscript, and/or strikethrough
Quoting long sentence (using nested blockquotes)

	// Just before switching jobs:
	// Add one of these.
	// Preferably into the same commit where you do a large merge.
	//
	// This started as a tweet with a joke of "C++ pro-tip: #define private public",
	// and then it quickly escalated into more and more evil suggestions.
	// I've tried to capture interesting suggestions here.
	//
	// Contributors: @r2d2rigo, @joeldevahl, @msinilo, @_Humus_,
	// @YuriyODonnell, @rygorous, @cmuratori, @mike_acton, @grumpygiant,

	# Compiled source #
	###################
	*.com
	*.class
	*.dll
	*.exe
	*.o
	*.so

	# Packages #

	" Vim syntax file
	" Language: Brainfuck
	" Maintainer: InternetUnexplorer <[email protected]>
	" Last Change: 2017 Feb 17
	" Version: 0.1

	if !exists("main_syntax")
	if version < 600
	syntax clear
	elseif exists("b:current_syntax")

	#include <iostream>
	#include <vector>
	#include <cstdlib>

	namespace 🔵 = std;
	using 🔢 = int;
	using 💯 = unsigned;
	using 💀 = void;
	using 🕖 = time_t;
	using 👌 = bool;

	Online kms host address:
	--------
	kms.digiboy.ir
	54.223.212.31
	kms.cnlic.com
	kms.chinancce.com
	kms.ddns.net
	franklv.ddns.net
	k.zpale.com
	m.zpale.com