Paulblish supports a bunch of standard html page content, as well as a few extra nifty little things that sets it apart. Please remember: this is hyper-personalised software, so I have included the things I want to have in a website.

If you want to modify or extend Paulblish then fork it and add your own, or contribute back, I would love free new features on my website so thanks!

Text formatting

Heading 1

Heading 2

Heading 3

Heading 4

Normal text, duh

  • bullet
  • points
  1. Numbered
  2. lists

Links to other sites

Wiki links to other markdown files

Here is a foot note [1]

Those <hr> things, see! ☝ 👇

More complex markdown things

Code blocks

With file titles and line numbers!

file.py
1
print("python code blocks")

Mermaid.js diagrams

When these are present then Paulblish will import the specific JS script to render it.

flowchart TD
    Start(Use hyper-personal software) --> Stop(Enjoy writing software again!)

Tables

Platform Table support
Others Results may vary
Paulblish Supported ⭐

Callouts

Call-outs!

Call-out blocks work too

Foldable call-outs too?

Yes, they work!

Images

Image, duh

(check the alt text to see it works too)

Configuration properties

Everything is controlled by Markdown files and the properties below are in frontmatter format at the top of each file.

Home.md

Most of the site config is controlled by this file. The content renders as your home page.

  • cname: creates a CNAME file with this content, for github pages support
  • avatar: relative path to an image will show an icon on the home page
  • description: used in the <meta name="description"> tag
  • title: used in the <title> tag
  • bluesky: link to a bluesky account will create a social icon
  • github: link to a github account will create a github icon
  • email: link to an email will create a mailto: link

Articles

Individual articles and tools or (any page for that matter) require these properties to be rendered as pages on your site:

  • author: Your name
  • created: date (also determines the next/prev link order!)
  • permalink: local path (uses directories to build paths, btw)
  • tags: builds static tag pages grouping related articles
  • publish: bool, determines if the article is generated or not

Custom features

Embedded HTML and JavaScript

Paulblish allows you to build simple web tools by writing html and js directly into a markdown file. Just make a code block start with html embedded and it'll render in the browser, see this example below:

The source for this looks like this (minus the embed keyword on the top line):

html
<button onclick="helloWorld()">Click me!</button>
<script>
    function helloWorld() {
	    alert("Wowza!");
    }
</script>

Other features

  • An RSS feed is automatically generated for you.
    • Note that only content under articles is included in the RSS feed.
  • As is a robots.txt and the relevant site map.
  • And also a 404 page which perhaps can be funnier...
  • Did you click on any of the tags at the top of the page yet? That's all just static pages too.
  • Various open graph and twitter tags are also generated (inspect the source of this page and look in the <head> and you'll see what I mean).

  1. Hello! Footnotes work! ↩︎