Skip to content

spencerlepine/blog

Repository files navigation

Spencer Lepine Blog Site [Deploy] GitHub Pages

Personal blog site built with MDX and Docusaurus, hosted for free on GitHub pages. This project includes automated workflows to cross-publish articles to Medium and Dev.to as well.

Screenshot

Architecture

⭐ Features

  • Automated Deployments: free hosting and automated CD with GitHub pages
  • Auto-generated Website: Docusaurus to create static files for a modern blog UI
  • Medium Publishing: GitHub Actions workflow to publish articles to Medium account
  • Dev.to Publishing: GitHub Actions workflow to publish articles to Dev.to account
  • Linter: pre-commit hook to enforce consistent Markdown formatting
  • Automated Image Optimizer: a GitHub Actions workflow using CalibreApp to compress images on every pull request

Publishing Articles

Create a new folder with the article markdown file and thumbnail image. Docusuarus will automatically deploy this to GitHub Pages.

/content
  /new-article-folder-name
    index.md
    thumbnail.jpg

Cross-Posting

Once you have published an article to the GitHub Pages blog, you can cross-post the article to Medium or Dev.to with very little additional effort.

Open the following workflows on GitHub, and enter the folder name when triggering a manual dispatch:

Demo

🛠️ Development

Local Development

$ yarn install
$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Production Build

$ yarn run build

This command generates static content into the build directory and can be served using any static contents hosting service.

ℹ️ Specifications

About

Personal blog built with MDX and Docusaurus, hosted for free on GitHub Pages. Includes workflows cross-post to Medium and Dev.to

Topics

Resources

Stars

Watchers

Forks