A quick, all in one stop for someone to get a blog presence up and running.
The world needs your voice. Good on you for putting it out there.
If you have questions about this project or how to use it, don't hesitate to open an issue (though please check the FAQs in this doc first just to be sure). We're happy to point you in the right direction. No question is too simple, and asking it will only help us all get better.
We've published these topics as individual blog posts so that they have their own space, and also to exercise our creation a little bit.
- Should you fork this or copy it?
- The Ingredients
- Prerequisites
- Opening the Project for Development
- Getting Started
- Running Commands
- Protecting Your Branch to ensure build steps run
- Setting up Scheduled Posts
- Setting up comments using Giscus
- Adding a live preview of pull requests using Netlify
- Deploying Your Blog
- Updating to a later version of our theme
- Updating navigation inks
- Where to go From Here
GitHub Pages, where we presume you are deploying, has some rules for what can be deployed. If deploying from the main branch, you have two options: (root), or the base directory of the repository, and /docs. In our case, we didn't want the other stuff in the root to get confused with the actual blog stuff, so we chose /docs because that's the name available that fits into our batteries-included setup with the least amount of fuss.
There are ways to customize this, particularly by using a gh-pages branch and creating a GitHub Action to push to it, but we figured that might be over-complicated. Feel free to reach out if you want to set that up and we may follow up with some more on this in the future.
.markdownlintrc is for the GitHub Actions build step, and .markdownlint.json is for the VS Code extension that underlines issues. We'll see if we can combine them into one file, but that's why they exist currently.