Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/chrisdonahue/md-pub

Simple template for deploying Markdown as static HTML via GitHub pages

https://github.com/chrisdonahue/md-pub

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.5%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Simple template for deploying Markdown as static HTML via GitHub pages

Basic Info
  • Host: GitHub
  • Owner: chrisdonahue
  • License: mit
  • Language: JavaScript
  • Default Branch: main
  • Size: 43 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created 10 months ago · Last pushed 10 months ago
Metadata Files
Readme License

README.md

Markdown Publisher

Markdown Publisher (md-pub) enables clean, rapid deployment of Markdown content as static HTML via GitHub Actions/Pages. A "keep it simple" alternative to things like Jekyll, Hugo, etc.

Code: https://github.com/chrisdonahue/md-pub

Output: https://chrisdonahue.com/md-pub

Features

  • Clean Markdown structure, mirrored 1:1 in HTML
  • Uses GitHub Actions to build and deploy the site to GitHub Pages
  • Small, hackable JS codebase (see .render directory)
  • Arbitrary static assets (images, etc.)
  • Multiple pages, directories, relative links and anchors
  • YAML frontmatter metadata support
  • MIT licensed

Usage instructions

  1. Fork the repository (probably change the repo name as well)
  2. Go to your repository settings and enable GitHub Pages via GitHub Actions
  3. Edit the README.md (or any other markdown file) with your content
  4. Edit .render/config.yml to your liking
  5. Customize .render/template to your liking
  6. Commit and push the changes
  7. Wait for the GitHub Actions to build and deploy the site

Testing locally

sh npm init -y npm install marked jsdom dompurify js-yaml node .render/render.js python3 -m http.server --directory _site 8080

Assets

Put your assets anywhere in the repo and use them as expected:

Markdown Publisher Logo

Owner

  • Name: Chris Donahue
  • Login: chrisdonahue
  • Kind: user
  • Location: Pittsburgh

Assistant professor @ CMU CSD. Part-time research scientist at Google Magenta. Machine learning for music, and creative interaction.

GitHub Events

Total
  • Push event: 14
Last Year
  • Push event: 14

Dependencies

.github/workflows/deploy.yml actions
  • actions/checkout v4 composite
  • actions/deploy-pages v4 composite
  • actions/setup-node v4 composite
  • actions/upload-pages-artifact v3 composite