Skip to content

robb-j/static-page

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 

Static Page

For when you want to quickly throw up a not-so-terrible-looking html page and you only want to write markdown. This repo is a node.js app which compiles assets with unified, remark and rehype, styles them with bulma then deploys them with docker.

Table of contents

Usage

Say you want a quick holding page and you have a markdown file with content in.

content.md

---
title: Coming Soon
subtitle: You'll have to wait a little bit longer
theme: #6b2636
---

# Coming Soon

Etiam porta sem malesuada magna mollis euismod. Etiam porta sem malesuada magna mollis euismod. Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.

Then you want to quickly deploy it using docker:

get the latest version tag here

docker run -it --rm \
  -p 3000:3000 \
  -v `pwd`/content.md:/app/page.md \
  robbj/static-page:vX.Y.Z

Then visit http://localhost:3000 and you'll have a page like this:

A screenshot showing the generated static page

Content

Make sure to mount your markdown file at /app/page.md so the container knows what to render.

Front matter

There are currently 3 values you can set in the front matter

  • titlerequired The title of the page
  • subtitle – An optional subtitle of the page
  • theme – A css colour for the theme of the page

Favicon

You can override the favicon by docker bind-mounting it to /app/src/favicon.png.

Health check

There is a health check endpoint at /healthz which will return a http/200 if all is clear. If the server is terminating it will return a http/503.

GET /healthz

Arguments

You can pass these arguments to configure how the server runs:

  • --port - What port to run on (default: 3000)
  • --page - What markdown file to load, relative to /app (default: page.md)

Development

Setup

To develop on this repo you will need to have Docker and node.js installed on your dev machine and have an understanding of them. This guide assumes you have the repo checked out and are on macOS, but equivalent commands are available.

Commands

# Install npm packages
npm install

# Run the development server
# -> It will compile the html & css and serve them at localhost:3000
# -> It watches for file changes using `nodemon` and restarts the server
npm run dev

# Generate the table of contents for this readme
npm run gen-readme-toc

Code formatting

This repo uses Prettier to automatically format code to a consistent standard. It works using the husky and lint-staged packages to automatically format code whenever code is committed.

You can manually run the formatter with npm run format if you want.

Prettier is configured in .prettierrc.yml and also ignores files using .prettierignore or those following a // prettier-ignore comment.

Releasing

Building the image

This repo uses GitHub Actions to build, tag and push a container to GitHub packages. Use the npm version command to create a new version and it will build and push a new container with that version. This means that all images are semantically versioned.

# Deploy a new version of the CLI
npm version # major | minor | patch
git push --follow-tags

Future work

  • Watch for file changes and regenerate the in-memory page

This repo was setup with robb-j/node-base

About

Generate a html page from markdown and serve it over http with docker

Resources

Stars

Watchers

Forks