https://github.com/grantbirki/software

https://github.com/grantbirki/software

hugo software-engineering website

Last synced: 10 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/grantbirki/software
• Owner: GrantBirki
• License: mit
• Created: 2025-02-12T06:09:35.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-10T18:55:09.000Z (12 months ago)
• Last Synced: 2025-05-16T16:08:35.200Z (10 months ago)
• Topics: hugo, software-engineering, website
• Language: CSS
• Homepage: https://software.birki.io/
• Size: 21.1 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# software

[![deploy](https://github.com/GrantBirki/software/actions/workflows/deploy.yml/badge.svg)](https://github.com/GrantBirki/software/actions/workflows/deploy.yml)

[![Unlock On Merge](https://github.com/GrantBirki/software/actions/workflows/unlock-on-merge.yml/badge.svg)](https://github.com/GrantBirki/software/actions/workflows/unlock-on-merge.yml)

[![ci](https://github.com/GrantBirki/software/actions/workflows/ci.yml/badge.svg)](https://github.com/GrantBirki/software/actions/workflows/ci.yml)

## Development

First, run `script/bootstrap` to get your environment set up for development. This will install the necessary dependencies.

Now, to run the site locally, simply run:

```bash

hugo server -D

```

Now you can visit [`localhost:1313`](http://localhost:1313/) to see the site.

### Open Graph Images

If you wish to render open graph images, you can use the following commands:

```bash

script/images

```

Then copy the resulting PNGs that got generated from the front matter of your blog posts into their corresponding `content/posts/` directories.

The text on the open graph images comes from the following front matter fields of a blog post:

```yaml

ogTitle: Grant Birkinbine

ogDescription: "Here is some description"

```

After you drop the resulting PNGs into your `content/posts/` directories, you can point the following front matter field to the PNG file:

```yaml

ogImage: /posts/example/og.png

```