Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/butlerx/cianbutler.ie

Personal website
https://github.com/butlerx/cianbutler.ie

Last synced: about 1 month ago
JSON representation

Personal website

Awesome Lists containing this project

README

        

# cianbutler.ie

![with-coffee](https://img.shields.io/badge/made%20with-%E2%98%95%EF%B8%8F%20coffee-yellow.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/butlerx/cianbutler.ie/blob/master/LICENSE.md)

A Hugo static site to display past work experience and projects I've worked on.

# Installation

Run `make build` to install dependencies and build the site.

# Usage

## Development

To Preview the site do `make serve` then open a browser and navigate to
`localhost:1313`. The Site will live reload based on any changes.

## Publish

To Build the site for deployment run `make build`, the site will be output to
`public` folder. This can then be served from any hosting. The site is auto
deployed using cloudflare hosting

## PDF

To Export a PDF on the `me` page run `make print`, this is save `cv.pdf` in the
root dir.

## Content

All pages content sections can be edited from `./src/content`. These files are
simple markdown with front-matter yaml

A portion of the content is stored in `data` such as `work.yaml`, and
`education.yaml`. The text in the yaml files are treated as markdown and
rendered out in to the templates.

The Social links can be found in `data/info.yaml`.

## Github

A portion of the site uses Github as a source for rendering templates. Given it
is not possible to render graphql data from hugo, `github.ts` exists.
`github.ts` is a deno serverless function to etl data from github's graphql api
for use in hugo.