Skip to content

Instantly share code, notes, and snippets.

@Velocet

Velocet/README.md

Last active May 3, 2024 17:43
Show Gist options
  • Save Velocet/fffc0008052abdf91494616f9e7071ad to your computer and use it in GitHub Desktop.
Save Velocet/fffc0008052abdf91494616f9e7071ad to your computer and use it in GitHub Desktop.
Download ZIP
GitHub README.md Template with ToC, Centered (+ formatted) Text, Top-Link, etc.
Raw
README.md

:trollface:
GH README Template

  • Put the index link above the header

  • Use id and name for index links

  • Leave a blank line after an html opening to get working markdown styling

  • List of usable HTML tags

$\textcolor{purple}{Table\ of\ Contents}$

  1. Introduction
  2. 1st paragraph
  3. 2nd paragraph

This is the introduction

Some introduction text, formatted in heading 2 style. Italic.

Centered Table (and don't ask me why it renders this way...)

1st Paragraph

The first paragraph is about colored text with LaTeX or a diff codeblock:

$${\color{grey}Hack \space \color{lightblue}The \space \color{blue}Planet}$$

$\mathfrak{\color{lime}{io \ homecontrol}}$

$\text{Plain Text}$

$\fbox{Plain Text inside Box}$

- NOTE: text in red
- NOTE: text in red
+ NOTE: text in green
! NOTE: text in orange
# NOTE: text in gray
@@ NOTE: text in purple (and bold)@@

SVG Text Example

Sub paragraph

This is a sub paragraph, formatted in heading 3 style.

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