Skip to content

easy-astro-blog-creator/easy-astro-blog-creator

Repository files navigation

Alt text

Easy Astro Blog Creator

He not busy being born is busy dying

  • Create for your life and beyond with complete control of your content.
  • Free, using open source tools and professionally respected Github Pages.
  • Easy no-code, in-browser user experience.
  • Check out a live demo -> EasyABC Live Demo

Alt text

Your first post online in 5m ⬇️

Get started with the live documentation.

Setup

Your Github Repo

Alt text
  • Name your repository with the format: GITHUB_USERNAME.github.io. This format must be used!
    • For example mine is shelbyjenkins.github.io.
Alt text
  • Create a codespace from your forked repo.
Alt text

Preview the site

  • It will take a 60-120s for the codespace to build for the first time. When it's done, a new terminal will automatically start and npm run dev will be run starting the local dev server for you.

  • Click on the link in the terminal. This will open a local version of the site in your browser. You can use this to preview your changes.

Alt text

Publish your Blog

Personalization

  • Every setting you need to change along with instructions for them will be in public/easyAbcUserConfig.ts

Adding your content

  • Your content will live in the public/personal-blog/blog folder.
    • By adding a a file to this folder, it will automatically be added to the blog.
  • Use the public/personal-blog/blog/template as a starter by copying and pasting it to duplicate it. Then rename the folder and .md file inside it to match.
  • Your new blog post will now be in your browser!

Working with markdown

  • Markdown is straight forward and you defintely use it in some form already. For example: Slack and Discord both use flavors of markdown.

  • You can write in your favorite text editor and convert to markdown with tools like xyz and zyx.

Deploy to Github Pages

  • In your Github repository go to the settings and find the pages panel.

    • Set the Source dropdown to Github Actions.
Alt text
  • Create your first commit and Push it!

Why

No Paywalls and Walled Gardens.

  • Blogging platforms like Medium put your posts behind a paywall. Others like Substack and Dev.to might someday do the same.

  • Linkedin and other social media are in the business of controlling your content. It can make organic discovery of your content via SEO difficult or impossible.

    Github and Git is pretty great!

  • Git gives you a higher level of version control (saving), remote editing, and redudancy.

  • You maintain complete control of your work to share, edit, or export for other platforms.

  • Github Pages are free (for now), but because it's built on Git you can export to another provider easily.

    It's more professional.

  • A Github Page is considered safe to click on as a common, well known, non-paywalled service.

  • You can use your own domain name and your own styling to really create something unique.

    It's fun!

  • If you are comfortable with not understanding everything, it's an enjoyable experience to create and learn.

  • It's actually really easy (30m-60m).

Additional Documentation

Creating Posts

Markdown

Design

Credit

This project used the Astro Blog example as a starting point.

Dynamic images and presets are from Oliver Speir's remark-imgattr