Giter Club home page Giter Club logo

humanutility.github.io's Introduction

Humanutility Blog

This repository contains the blog for the Human Utility project! It runs on GitHub Pages using Jekyll.

Getting the site

  1. Make sure that you have Git installed and configured.
  2. Clone this repository to your computer.

Starting the site

If you're using a Mac or Linux, go to the terminal and run:

script/server

If you're using a Windows machine, go the command prompt and run:

jekyll serve --watch

In both cases, you can open a new browser and head to http://0.0.0.0:4000 to see the site ✨ live ✨.

Writing posts

New posts are written in Markdown. To add a new post, create a new file under the posts/ folder. It should start with a date in the format of YYYY-MM-DD-, followed by any title you want.

Each post needs to start with some frontmatter, which is sort of like metadata describing the post. Each post should have the following keys:

  • title, which is the title of the post
  • permalink, which is the URL link. Typically this is the person's name being highlighted.
  • description, which is a short description of the person being highlighted.
  • image, which is an image of the person being highlighted.

For example, this might look like this:

---
title: Meet Loria—The First Person The Human Utility Ever Helped
permalink: /loria-detroit/
description: Meet Loria. The first person in Detroit The Human Utility ever helped with a water bill.
image: https://www.dropbox.com/s/k2i3ivenw1uobxi/loria.jpeg?dl=1
---

These metadata keys (image, title, etc.) are important, because they are used by the jekyll-seo-tag plugin to create cards for Twitter and Facebook.

Publishing posts

Any post merged into gh-pages will automatically go live on the internet!

Technical details

Plugins used

The following plugins are used to help make the site:

TODO

  • Fix header and footer so that they match the rest of the website
  • A lot of the SCSS styles were just stolen from Stripe. The files in the _sass/ folder should be reviewed to make sure they're actually being used.
  • There should probably be shared on Twitter/Facebook buttons.

humanutility.github.io's People

Contributors

tiffani avatar gjtorikian avatar

Watchers

Mohd sharil ridzwan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.