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

Revisions

  1. Velocet revised this gist May 3, 2024. 1 changed file with 0 additions and 39 deletions.
    39 changes: 0 additions & 39 deletions README_minimal.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,39 +0,0 @@
    <!-- # GitHub README Template -->

    <div align="center">

    # GH README Template

    | ![description](https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png) |
    | :---------------------------------------------------------------------------------: |
    | footer |

    </div>

    ## Table of Contents

    - [The Introduction](#the-introduction)
    - [Paragraph](#paragraph)
    - [Sub paragraph](#sub-paragraph)

    ---

    ## The Introduction

    <div align="center">

    **Some centered introduction text**

    </div>

    <div align="right"><a href="#table-of-contents">&uarr;</a></div>

    ## Paragraph

    The first paragraph.

    <div align="right"><a href="#table-of-contents">&uarr;</a></div>

    ### Sub-Paragraph

    This is a sub paragraph, formatted in heading 3 style.
  2. Velocet revised this gist May 3, 2024. 1 changed file with 29 additions and 52 deletions.
    81 changes: 29 additions & 52 deletions README.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,70 +1,47 @@
    <!-- # GH README Template --><!-- centered title v1: plain markdown -->
    <!-- <h1 align="center">GH README Template</h1>--><!-- centered title v2: html -->
    <div align="center"><h1><!-- centered title v3: html + markdown/emoji support -->
    <!-- # GitHub README Template -->

    :trollface:<br/>GH README Template<!-- A centered title inside a table with markdown -->
    :-:
    </h1></div>
    <div align="center">

    <!--
    Badges: [shields.io](https://shields.io) | Example: [![](https://img.shields.io/badge/velocet-blue?style=for-the-badge)](https://github.com/velocet/)
    <img src="https://raw.githubusercontent.com/Velocet/Velocet/master/FelixTheCat.gif" alt="Resized Image: Only Width. Height=Autocalc." width="250"/>
    -->
    # GH README Template

    ---
    | ![description](https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png) |
    | :---------------------------------------------------------------------------------: |
    | footer |

    - > 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](https://github.com/gjtorikian/html-pipeline/blob/main/lib/html_pipeline/sanitization_filter.rb)
    # $\textcolor{purple}{Table\ of\ Contents}$<a id="toc" name="toc"></a>
    1. [Introduction](#introduction)
    1. [1st paragraph](#paragraph-1)
    - [First Sub paragraph](#sub-paragraph-1)
    - [Second Sub paragraph](#sub-paragraph-2)
    1. [2nd paragraph](#paragraph-2)
    ---
    <a id="introduction" name="introduction"></a>
    ## This is the introduction
    <div align="center">

    ***Some introduction text, formatted in heading 2 style. Italic.***
    Centered Table (and don't ask me why it renders this way...)
    :-:
    </div>

    ---
    <div align="right"><!-- Place at the bottom of every paragraph or at the top of every paragraph? ;) -->

    [TOP](#toc)</div><a id="paragraph-1" name="paragraph-1"></a>
    ## 1st Paragraph
    The first paragraph is about colored text with `LaTeX` or a `diff` codeblock:
    ## Table of Contents

    $${\color{grey}Hack \space \color{lightblue}The \space \color{blue}Planet}$$
    - [The Introduction](#the-introduction)
    - [Paragraph](#paragraph)
    - [Sub paragraph](#sub-paragraph)

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

    $\text{Plain Text}$
    ## The Introduction

    $\fbox{Plain Text inside Box}$
    <div align="center">

    **Some centered introduction text**

    > ```diff <!-- Dunno why this needs no closing tags... -->
    > - NOTE: text in red
    </div>

    ```diff
    - NOTE: text in red
    + NOTE: text in green
    ! NOTE: text in orange
    # NOTE: text in gray
    @@ NOTE: text in purple (and bold)@@
    - NOTE: text color 1
    + NOTE: text color 2
    ! NOTE: text color 3
    # NOTE: text color 4
    @@ NOTE: text in purple and bold @@
    ```

    ![SVG Text Example](https://github.com/Velocet/dotfiles/raw/master/google.svg) <!-- sadly no scaling -->
    <div align="right"><a href="#table-of-contents">&uarr;</a></div>

    ## Paragraph

    The first paragraph.

    <div align="right"><a href="#table-of-contents">&uarr;</a></div>

    <div align="right"><!-- Place at the bottom of every paragraph or at the top of every paragraph? ;) -->
    ### Sub-Paragraph

    [TOP](#toc)</div><a id="sub-paragraph-1" name="sub-paragraph-1"></a>
    ### Sub paragraph
    This is a sub paragraph, formatted in heading 3 style.
    This is a sub paragraph, formatted in heading 3 style.
  3. Velocet revised this gist May 3, 2024. 1 changed file with 5 additions and 5 deletions.
    10 changes: 5 additions & 5 deletions README_minimal.md
    View file
    Original file line number Diff line number Diff line change
    @@ -2,15 +2,15 @@

    <div align="center">

    GH README Template<br/>:trollface:
    # GH README Template

    | ![description](https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png) |
    | :---------------------------------------------------------------------------------: |
    | footer |

    </div>

    # [Table of Contents](#table-of-contents)
    ## Table of Contents

    - [The Introduction](#the-introduction)
    - [Paragraph](#paragraph)
    @@ -22,17 +22,17 @@ GH README Template<br/>:trollface:

    <div align="center">

    **Some introduction text in a Centered Table with Markdown**
    **Some centered introduction text**

    </div>

    <div align="right">[&uarr;](#table-of-contents)</div>
    <div align="right"><a href="#table-of-contents">&uarr;</a></div>

    ## Paragraph

    The first paragraph.

    <div align="right">[&uarr;](#table-of-contents)</div>
    <div align="right"><a href="#table-of-contents">&uarr;</a></div>

    ### Sub-Paragraph

  4. Velocet revised this gist May 3, 2024. 1 changed file with 16 additions and 15 deletions.
    31 changes: 16 additions & 15 deletions README_minimal.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,38 +1,39 @@
    <!-- markdownlint-disable -->
    <!-- markdown-link-check-disable -->
    <!-- NOTE markdown linter disabled cause this is a template -->
    <!-- # GitHub README Template -->

    <div align="center"><h1><!-- # GitHub README Template -->
    <div align="center">

    GH README Template<br/>:trollface:

    | ![description](https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png) |
    | :---------------------------------------------------------------------------------------: |
    | :---------------------------------------------------------------------------------: |
    | footer |

    </h1></div>
    </div>

    # [Table of Contents](#table-of-contents)

    - [The Introduction ](#the-introduction)
    - [1st Paragraph](#1st-paragraph)
    - [The Introduction](#the-introduction)
    - [Paragraph](#paragraph)
    - [Sub paragraph](#sub-paragraph)

    ---

    ## The Introduction <a id="introduction" name="introduction"></a>
    ## The Introduction

    <div align="center">

    **Some introduction text in a Centered Table with Markdown**

    </div><div align="right">
    </div>

    <div align="right">[&uarr;](#table-of-contents)</div>

    ## Paragraph

    [&uarr;](#table-of-contents)</div>
    ## 1st Paragraph
    The first paragraph.

    <div align="right">
    <div align="right">[&uarr;](#table-of-contents)</div>

    ### Sub-Paragraph

    [&uarr;](#table-of-contents)</div>
    ### Sub paragraph
    This is a sub paragraph, formatted in heading 3 style.
  5. Velocet revised this gist May 3, 2024. 1 changed file with 38 additions and 1 deletion.
    39 changes: 38 additions & 1 deletion README_minimal.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1 +1,38 @@
    ‎‎​
    <!-- markdownlint-disable -->
    <!-- markdown-link-check-disable -->
    <!-- NOTE markdown linter disabled cause this is a template -->

    <div align="center"><h1><!-- # GitHub README Template -->

    GH README Template<br/>:trollface:
    | ![description](https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png) |
    | :---------------------------------------------------------------------------------------: |
    | footer |

    </h1></div>

    # [Table of Contents](#table-of-contents)

    - [The Introduction ](#the-introduction)
    - [1st Paragraph](#1st-paragraph)
    - [Sub paragraph](#sub-paragraph)

    ---

    ## The Introduction <a id="introduction" name="introduction"></a>

    <div align="center">

    **Some introduction text in a Centered Table with Markdown**

    </div><div align="right">

    [&uarr;](#table-of-contents)</div>
    ## 1st Paragraph
    The first paragraph.

    <div align="right">

    [&uarr;](#table-of-contents)</div>
    ### Sub paragraph
    This is a sub paragraph, formatted in heading 3 style.
  6. Velocet revised this gist May 3, 2024. 1 changed file with 1 addition and 0 deletions.
    1 change: 1 addition & 0 deletions README_minimal.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1 @@
    ‎‎​
  7. Velocet renamed this gist May 1, 2024. 1 changed file with 0 additions and 0 deletions.
    0 README.me → README.md
    View file
    File renamed without changes.
  8. Velocet created this gist May 13, 2023.
    70 changes: 70 additions & 0 deletions README.me
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,70 @@
    <!-- # GH README Template --><!-- centered title v1: plain markdown -->
    <!-- <h1 align="center">GH README Template</h1>--><!-- centered title v2: html -->
    <div align="center"><h1><!-- centered title v3: html + markdown/emoji support -->

    :trollface:<br/>GH README Template<!-- A centered title inside a table with markdown -->
    :-:
    </h1></div>

    <!--
    Badges: [shields.io](https://shields.io) | Example: [![](https://img.shields.io/badge/velocet-blue?style=for-the-badge)](https://github.com/velocet/)
    <img src="https://raw.githubusercontent.com/Velocet/Velocet/master/FelixTheCat.gif" alt="Resized Image: Only Width. Height=Autocalc." width="250"/>
    -->

    ---

    - > 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](https://github.com/gjtorikian/html-pipeline/blob/main/lib/html_pipeline/sanitization_filter.rb)

    # $\textcolor{purple}{Table\ of\ Contents}$<a id="toc" name="toc"></a>
    1. [Introduction](#introduction)
    1. [1st paragraph](#paragraph-1)
    - [First Sub paragraph](#sub-paragraph-1)
    - [Second Sub paragraph](#sub-paragraph-2)
    1. [2nd paragraph](#paragraph-2)
    ---
    <a id="introduction" name="introduction"></a>
    ## This is the introduction
    <div align="center">

    ***Some introduction text, formatted in heading 2 style. Italic.***
    Centered Table (and don't ask me why it renders this way...)
    :-:
    </div>

    ---
    <div align="right"><!-- Place at the bottom of every paragraph or at the top of every paragraph? ;) -->

    [TOP](#toc)</div><a id="paragraph-1" name="paragraph-1"></a>
    ## 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}$


    > ```diff <!-- Dunno why this needs no closing tags... -->
    > - NOTE: text in red

    ```diff
    - 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](https://github.com/Velocet/dotfiles/raw/master/google.svg) <!-- sadly no scaling -->

    <div align="right"><!-- Place at the bottom of every paragraph or at the top of every paragraph? ;) -->

    [TOP](#toc)</div><a id="sub-paragraph-1" name="sub-paragraph-1"></a>
    ### Sub paragraph
    This is a sub paragraph, formatted in heading 3 style.