README.tpl.md

{repo}

Good News: Your blog is ready!

Just a few steps to Finish Up:

1. Enable GitHub Pages
   • Visit github.com/{owner}/{repo}/settings/pages
   • Select Source Branch: gh-pages
   • Select / (root) (default)
   • Save
2. Create your First Post
   • Visit bliss.js.org to make your first post.
     • bliss.js.org/#/?o={owner}&r={repo}&b={branch}&ght
3. Enable Comments (optional)
   • Visit github.com/apps/utterances
   • Click Install
   • Select {owner} and {repo}
   • You're all set! Comments will become issues on this repo!
   • To disable comments, comment out utterances_* in config.yaml

View Blog

You can view your blog at {owner}.github.io/{repo}.

New Post

Create New Post

You can make new blog posts as easy as Gists. Just write your tweet post, and Bliss will fill out the Front Matter for you.

1. 🔎 Type bli in your browser's omnibar and hit enter (assuming you followed the steps above).
   • (or visit bliss.js.org directly)
2. 📝 Write your post
3. 💾 Click Add to Github, and then Commit new file

Your new post will build automatically.

Want to Learn Markdown? Check out The Complete GitHub Markdown Cheat Sheet.

Edit Post

Manage your existing posts directly on GitHub.
Don't worry, .GitInfo.lastmod will pull the new "updated at" date from git!

/content/blog/

Just click edit, then edit and commit!

Manual Builds

It's always nice to know that when the 💩 hits the fan, you can still get 💩 done all on your own.

1. Edit config.yaml to taste...
   or bash ./scripts/ga-template.sh.
2. Install hugo and node via Webi:

   curl -sS https://webinstall.dev/[email protected] | bash
   curl -sS https://webinstall.dev/node@v16 | bash
   # or
   # bash ./scripts/install-deps.sh

3. Clone and setup repo

   git clone [email protected]:{owner}/{repo}
   pushd ./{repo}
   git submodule init
   git submodule update
   hugo
   # or
   # bash ./scripts/build.sh

4. Inspect the build

   ls ./public

5. Deploy to GitHub pages

   git checkout gh-pages
   rsync -avhP public/ ./
   rm -rf public/
   git add ./
   git commit -m "deploy: latest build"
   git push
   # or
   # bash ./scripts/deploy.sh

Troubleshooting

Don't see gh-pages?

Generally the Use this template process takes about 30s. You check to see if it's complete at github.com/{owner}/{repo}/actions.

Once the Action finishes it may take up to 5 minutes for the first Pages deploy to complete.

Something else wrong?

Open an issue on https://github.com/BeyondCodeBootcamp/bliss-template.