README.md

📄 Static guides with HackUPC documentation

Run project

Needs: Ruby

First of all, let's copy the project!

git clone https://github.com/hackupc/guides && cd guides

Local

1. gem install jekyll && gem install jemoji
2. jekyll serve --watch

Docker

1. docker build -t jekyll .
2. docker run -v $(pwd):/site -p 4000:4000 jekyll

Deploy

1. Push changes to master
2. There's no 2

Deployment is done automatically by GitHub pages. You don't need to do anything else than pushing to master.

Development

Add new page

1. Add Markdown or HTML file under directory _pages
2. Start with the following snippet (edit title and description at your will)

---
layout: base
title: Hacker Guide
description: This is a hacker guide for HackUPC 2018
---

Want to contribute?

Please read our Code of Conduct, then follow these guidelines