Skip to content

Instantly share code, notes, and snippets.

@RichNSD
Created September 27, 2023 05:43
Show Gist options
  • Select an option

  • Save RichNSD/8b5332db5fb64b7bcf4b3ce74d25c867 to your computer and use it in GitHub Desktop.

Select an option

Save RichNSD/8b5332db5fb64b7bcf4b3ce74d25c867 to your computer and use it in GitHub Desktop.
Markdown Formatting Tests

Markdown Preview Tests

This is a test of the Markdown Styler plugin.


Basic Features

Lists

Testing Ordered Lists, Unordered Lists, and Checklists.

Ordered List

  1. First item
  2. Second item
    • Sub-Item
    • Sub-Item
  3. Third item

Unordered List

  • Beans
  • Spiky Bois
    • Porcupines
    • Hedgehogs
  • Charcoal

Tables

Basic Table Syntax

Column 1 Column 2 Column 3
Beans Hardware Ducks
Cheese Software Geese

Extended Table Syntax

Column 1 Column 2 Column 3
Beans Hardware Ducks
Cheese Software Geese

Code

Here is a sample of in-line code.

Fenced Code Blocks

Below are samples of fenced code blocks using Standard & Extended Markdown Syntax .

Basic Markdown Code Block

This is a simple fenced code block.

The HTML version would be the <pre>...</pre> element.

Basic HTML Code Block

This is a simple HTML code block.

Let's see how it renders.

Highlighted Code Blocks

Bash/Shellscript

cd "~"

function test() {
    if [[ -e "~/.bashrc" ]]; then
        echo "The ~/.bashrc file exists."
    else
        echo "The ~/.bashrc file does not exist."
    fi
}

JavaScript

function test_function() {
	console.log("This is a test.")
}

PowerShell

function New-AdvFunction {
    [CmdletBinding]
    param(
        [Parameter(Mandatory=$True,
                   Position=0,
                   HelpMessage=$Null,
                   ParameterSetName="Defaults",
                   ValueFromPipeline=$True,
                   ValueFromPipelineByPropertyName=$True)] <# Allows you to call on a value using the property name #>
        [ValidateNotNullOrEmpty()]
        [SupportsWildcards]
        [Alias("S","String")]
        [string]$StringParam, 
        
        [Parameter(Mandatory=$False,
                   HelpMessage=$Null,
                   ParameterSetName="Defaults",
                   ValueFromPipeline=$True,
                   ValueFromPipelineByPropertyName=$True)]
        [SupportsWildcards]
        [Alias("A","Array")]
        [string[]]$ArrayParam,
        
        [Parameter(Mandatory=$False,
                   HelpMessage=$Null,
                   ParameterSetName="Defaults",
                   ValueFromPipeline=$False,
                   ValueFromPipelineByPropertyName=$False)]
        [Alias("B","Bool")]
        [switch]$SwitchParam
    )
    
    
    #★ Begin Process Block
    begin {
        #
    }
    
    #★ Main Process Block
    process {
        #
    }
    
    #★ End Process Block
    end {
        #
    }



<#
.SYNOPSIS
One-Sentence Summary.

.DESCRIPTION
Short pararagraph summary.

.PARAMETER Name
Name Description

.PARAMETER Date
Date Description

.NOTES
Extra Details.

.EXAMPLE 
New-Function -Name 'Cement'

.EXAMPLE 
New-Function -Name 'Bacon' -Date 'Today'

.ROLE
[ name of the 'user role' for the help topic ]
(optional)

.FUNCTIONALITY
[ keyword(s) describing the intended function ]
(optional)

.FORWARDHELPCATEGORY
Function

.FORWARDHELPTARGETNAME
Command-Name (optional)

.LINK
https://github.com/NewSpectrum/PowerShell-PowerUps/wiki
.LINK
Related-Function
.LINK
Related-Cmdlet
.LINK
about_Related_Content
#>
}

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