Skip to content

adambrett/md-ipsum

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

md-ipsum

Copy snippets of markdown and paste them into your project.

Description

md-ipsum is placeholder markdown for designers and developers testing markdown rendering, and a quick reference for the syntax of common formats. Each snippet is shown as raw, copy-pasteable source in a text box - click a snippet's title to copy it to your clipboard.

Snippets are grouped by flavour, because "markdown" isn't one thing:

Flavour Notes
CommonMark The reference spec.
GFM GitHub Flavored Markdown - CommonMark plus tables, task lists, strikethrough, autolinks, footnotes.
Goldmark Hugo's renderer - GFM plus definition lists and a typographer.
Pandoc The universal document converter's Markdown, aimed at academic & print output (LaTeX/PDF, DOCX) - everything Goldmark has, plus citations & bibliographies, math, fenced divs, cross-references, and grid tables.
WhatsApp Chat formatting: *bold*, _italic_, ~strike~, ```mono```.
Slack mrkdwn: *bold*, _italic_, ~strike~, <url|text> links.
Discord **bold**, __underline__, ~~strike~~, ||spoiler||, headings.
JIRA Atlassian wiki markup (h1., {code}, ||tables||, ^sup^) - not actually markdown but parts are borrowed.

Within each flavour, snippets are ordered with unique first, followed by styles that are different to other flavours, then the remainder are simplest → complex. Unique and different snippets are colour-coded: gold = a capability unique to that flavour, blue = a shared idea written with different syntax (the gotchas), uncoloured = the same in all formats. A ? in the header explains the key.

Usage

Visit the site, pick a flavour from the header, and click any snippet's title to copy its source.

Development

Requires Hugo extended 0.147.2:

brew install hugo

Then:

make run     # serve locally with live reload at http://localhost:1313/
make build   # production build into ./public/
make clean   # remove build artefacts
make help    # list targets

Adding a snippet

Drop a new content/<flavour>/<slug>.md:

---
title: "My Snippet"
weight: 130
tier: different   # optional: "unique" (gold) or "different" (blue)
---
Your raw markdown here.

weight orders the snippet within its flavour (lowest first). The body is the source shown in the text box, emitted verbatim and auto-escaped, so write it as natural markdown - no entity-escaping needed. Omit tier for an ordinary (uncoloured) snippet.

License

Dual-licensed:

  • Snippets (content/) — BSD-3-Clause. Use them in any project, including commercial ones.
  • The site (templates, styles, scripts, design) — CC BY-NC-SA 4.0. Fork and contribute freely; don't run a commercial clone.

About

A hugo website for copyable snippets of markdown to paste into your project.

Topics

Resources

License

Stars

Watchers

Forks

Contributors