This is the source code for my website, blog, and portfolio at andyatkinson.com built with Jekyll and hosted on GitHub Pages.
Use Vale! How I use it
- Code screenshots: https://www.marclittlemore.com/create-pretty-code-screenshots/
%s/”/"/g
%s/“/"/g
- Use
h4
for headings - Add tags to the post
- In Vim
:set wrap
/:set nowrap
to enable/disable soft wrap - In Vim
leader-s
enables spell check mode, check spelling, add words withzg
Vim Spell Checking by Thoughtbot - Use initial caps in post titles
- Use
<mark/>
to highlight a section - Use footnotes when appropriate
- For blockquotes, add a
<cite/>
- On macOS, preview with MacDown MacDown The open source Markdown editor for macOS.
- For section headings, use caps
- For product and company names, mind the CamelCase
- For dates on posts, use a date and not a time
- Bare markdown links are
<>
- Using footnotes: make a
[^footnote]
usage where you want it inserted, and a[^footnote]: Text <link>
at the bottom of the article - For Tags, use uppercased and pluralized words, when they're a category like "Podcasts"
The
This was worked around for now by inlining the contents of the include
for the social link icons does not work on Heroku but worked locally. The icons
folder is nested one layer deeper and it may just be that the relative filepath is not working.include
.
Multi-word tags had a whitespace character after the hyphen. Removed that so URLs worked.
site.baseurl
did not have a leading slash in _layouts/post.html
and did elsewhere, so this was breaking links. For now I manually inserted the leading slash in that file.
- Setting up Namecheap DNS with GitHub Pages
- Setting up GitHub Pages Custom Domains
- Setting up a Newsletter with Mailchimp
- Jekyll SEO plugin for GitHub Pages
bundle exec jekyll serve --incremental
I occasionally rm -rf _site
to remove the generated site completely. Changing config.yml
requires restarting the development server.
Set up hidden page initially as follows.
- Add to
_posts
with today's date - No tags
- No
date
in front matter - Add
hidden: true
in front matter, this is key - Publish it and reference the permalink. Confirm it's accessible but hidden from pagination and tag-feed.
Note: Date-based filename organizes post but isn't used in permalink.
When ready for general audience and syndicate as follows.
- Remove
hidden: true
front matter - Add date as current date for publishing purposes, e.g.
date: 2024-10-02 16:00:00
, set a future time (date and time of day, 24 hour time) in UTC, so it will be picked up - Add tag to trigger syndication (e.g. PostgreSQL)
- Push it, confirm permalink is same, it's in pagination and tag-feed