Giter Club home page Giter Club logo

us-tech-blog's Introduction

OpenTable Tech Europe Blog

The blog is built with Next.js and deployed as a static site to GitHub Pages.

Running locally

Start the Next.js development server to make changes:

# install dependencies
yarn install

# start dev server
yarn dev

Deploying

Commits to the master branch will be automatically deployed.

Writing blog posts

Create a new file

Blog posts are stored in the _posts folder in markdown format. To create a new post you can use the GitHub UI and copy over the front matter from a previous blog post, or you can use the NPM scaffold script when drafting a blog post locally:

# scaffold new post
yarn new "Blog post title"

Metadata

Blog posts need to specify the following metadata in the front matter:

Name Description
title title as you want it to appear in the blog post
date date in YYYY-MM-DD format (e.g. 2020-01-01)
author author name (can be full name or preferred name)
category engineering, backend, frontend, culture, or events

New authors should add a 400x400px headshot image to /public/images/authors with the file name matching the author name exactly.

Publishing

Blog posts should first be published in draft mode. You can do this by adding draft: true to a post's metadata. Blog posts in draft mode are accessible at the blog post URL but they don't appear publicly on the blog. This allows you to see what a blog post looks like when deployed and check everything looks okay.

us-tech-blog's People

Contributors

danielireson avatar ajcw avatar jeanice-n avatar savzzy avatar bitwisemercenary avatar matteofigus avatar dgiddins avatar dipunm avatar federicomaffei 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.