Skip to content

Ultra simple solution to make your own blog. Configured to be hosted on GitHub using actions. Forked from @vbuterin.

Notifications You must be signed in to change notification settings

il3ven/blogmaker-github-actions

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 Cannot retrieve latest commit at this time.

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Blogmaker

This is an ultra-simple blog publishing solution. It is configured to be hosted on GitHub and be automatically built using GitHub actions.

Dependencies for local development

  • pandoc
  • rsync (Only needed if you plan to publish the blog on your server)
    • Not needed if you are hosting on GitHub

How to use

See the posts directory for what a post should look like. Posts must be written in markdown, and filenames must end in ".md". Dates must be in (yyyy/mm/dd) format. All posts must be in the posts directory.

If you need a post to use MathJaX to format LaTeX equations, add the line

[pandoc]: <> (--mathjax)

to the config at the top of the post.

To compile a post to html, run ./publish.py posts/name_of_post.md (or ./publish.py posts/* to recompile everything). Compilation also happens on GitHub Actions.

Using your own server

Use ./publish.py --sync to upload the latest version of your site to your server (make sure to put your server details, as well as the site title and icon, in config.md).

For the server, the simplest setup is to use any VPS, apt install apache2, make sure apache2 is running, and just set the directory to /var/www/html.

Hosting on GitHub pages

  • Fork/clone this repo.
  • Turn on GitHub pages from settings and set the branch as gh-pages and directory as root.
  • Change the domain to your repo from config.md
  • Push changes to main and voila!

Credits:

  • https://hackmd.io for CSS styles.
  • @vbuterin for building and making his blogmaker open source.

About

Ultra simple solution to make your own blog. Configured to be hosted on GitHub using actions. Forked from @vbuterin.

Topics

Resources

Stars

Watchers

Forks

Languages

  • CSS 97.9%
  • Python 1.3%
  • HTML 0.8%