Skip to content

Project updates for partnership project between the Public Service Commission and Code for Canada.

License

Notifications You must be signed in to change notification settings

code-for-canada/psc-updates

 
 

Repository files navigation

PSC x Code for Canada project updates

Link to live site: https://code-for-canada.github.io/psc-updates/

This is a blog run by the Code for Canada fellows at the Public Service Commission. It contains monthly project updates. Overall these are considered public, but some items might link to some internal facing content.

Instructions on publishing a blog post

Edit /_posts/2018-11-3-update-1.md to publish a post.

Merging to 'master' will publish your updates to the site within a few minutes. Creating a new branch with a pull request is a way to get a review/confirmation of your content before publishing.

If you need to add an image, contact @caleybrock, who will help.

If you need to make a new file to make an additional post, hit the + icon in /_posts/ to create new content. Just make sure to include the front-matter block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-update-#.md

This Markdown Cheatsheet will be useful for formatting your post. It is recommended you use a markdown editor to preview your content before publishing. https://stackedit.io for example, can also help with auto-filling in markdown syntax.

How this site works

We forked Jekyll Now to make this blog.

Jekyll is a static site generator that's perfect for GitHub hosted blogs (Jekyll Repository)

Quick Start

Step 1) Fork Jekyll Now to your User Repository

Fork this repo, then rename the repository to yourgithubusername.github.io.

Your Jekyll blog will often be viewable immediately at https://yourgithubusername.github.io (if it's not, you can often force it to build by completing step 2)

Step 2) Customize and view your site

Enter your site name, description, avatar and many other options by editing the _config.yml file. You can easily turn on Google Analytics tracking, Disqus commenting and social icons here too.

Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. Your rebuilt site will be viewable a few seconds later at https://yourgithubusername.github.io - if not, give it ten minutes as GitHub suggests and it'll appear soon

There are 3 different ways that you can make changes to your blog's files:

  1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below).
  2. Use a third party GitHub content editor, like Prose by Development Seed. It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy.
  3. Clone down your repository and make updates locally, then push them to your GitHub repository.

Step 3) Publish your first blog post

Edit /_posts/2014-3-3-Hello-World.md to publish your first blog post. This Markdown Cheatsheet might come in handy.

First Post

You can add additional posts in the browser on GitHub.com too! Just hit the + icon in /_posts/ to create new content. Just make sure to include the front-matter block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md

Local Development

  1. Install Jekyll and plug-ins in one fell swoop. gem install github-pages This mirrors the plug-ins used by GitHub Pages on your local machine including Jekyll, Sass, etc.
  2. Clone down your fork git clone https://github.com/yourusername/yourusername.github.io.git
  3. Serve the site and watch for markup/sass changes jekyll serve
  4. View your website at http://127.0.0.1:4000/
  5. Commit any changes and push everything to the master branch of your GitHub user repository. GitHub Pages will then rebuild and serve your website.

About

Project updates for partnership project between the Public Service Commission and Code for Canada.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 89.7%
  • HTML 10.3%