From dc4d46756d3b798b3dcf68f80e8f981c49590e9a Mon Sep 17 00:00:00 2001 From: Jake Jarvis Date: Wed, 11 Dec 2019 10:52:15 -0500 Subject: [PATCH] update readme [skip ci] --- README.md | 19 ++++++++++++------- config.toml | 1 + netlify.toml | 4 ++-- package.json | 2 +- 4 files changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 524c6a46..679cc799 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # 🏡  [jarv.is](https://jarv.is/) -[![Netlify Status](https://api.netlify.com/api/v1/badges/a7403a53-fd9d-44c0-a708-a84d9fc1454d/deploy-status)](https://app.netlify.com/sites/jakejarvis/deploys) [![View website](https://img.shields.io/badge/view%20site-jarv.is-green)](https://jarv.is/) [![Hugo v0.60.1](https://img.shields.io/badge/hugo-v0.60.1-orange)](https://github.com/gohugoio/hugo) [![GitHub repo size](https://img.shields.io/github/repo-size/jakejarvis/jarv.is)](https://github.com/jakejarvis/jarv.is) [![License](https://img.shields.io/github/license/jakejarvis/jarv.is?color=red)](LICENSE.md) [![Twitter Follow](https://img.shields.io/twitter/follow/jakejarvis?label=Follow&style=social)](https://twitter.com/intent/user?screen_name=jakejarvis) +[![Netlify Status](https://api.netlify.com/api/v1/badges/a7403a53-fd9d-44c0-a708-a84d9fc1454d/deploy-status)](https://app.netlify.com/sites/jakejarvis/deploys) [![View website](https://img.shields.io/badge/view%20site-jarv.is-green)](https://jarv.is/) [![Hugo v0.60.1](https://img.shields.io/badge/hugo-v0.60.1-orange)](https://github.com/gohugoio/hugo) [![Dependabot](https://api.dependabot.com/badges/status?host=github&repo=jakejarvis/jarv.is)](https://github.com/jakejarvis/jarv.is/pulls?q=is%3Apr+label%3Adependencies) [![GitHub repo size](https://img.shields.io/github/repo-size/jakejarvis/jarv.is)](https://github.com/jakejarvis/jarv.is) [![License](https://img.shields.io/github/license/jakejarvis/jarv.is?color=red)](LICENSE.md) [![Twitter Follow](https://img.shields.io/twitter/follow/jakejarvis?label=Follow&style=social)](https://twitter.com/intent/user?screen_name=jakejarvis) + Personal website of [@jakejarvis](https://github.com/jakejarvis), created and deployed using the following: @@ -8,23 +9,27 @@ Personal website of [@jakejarvis](https://github.com/jakejarvis), created and de - [Netlify](https://www.netlify.com/) - [Commento](https://gitlab.com/commento/commento) -I keep an ongoing list of [blog post ideas](https://github.com/jakejarvis/jarv.is/issues/1) as an issue in this repo. +I keep an ongoing list of [blog post ideas](https://github.com/jakejarvis/jarv.is/issues/1) and [coding to-dos](https://github.com/jakejarvis/jarv.is/issues/11) as issues in this repo. -## Running a local testing server with Docker +## Running a local testing server -This site is built with [Hugo extended](https://github.com/gohugoio/hugo). To ensure consistency and compatibility, the [`Dockerfile`](Dockerfile) in this repository will download the Hugo binary and run a live testing server. +#### Using Hugo: -#### Usage: +Run `yarn install` then `yarn start` ([Yarn must be installed](https://yarnpkg.com/en/docs/install) first), then open [http://localhost:1313/](http://localhost:1313/). Pages will live-refresh when source files are changed. -Simply run `yarn docker:serve` ([install Yarn](https://yarnpkg.com/en/docs/install) first) or build manually with: +#### Using Docker: + +To ensure consistency and compatibility, the [`Dockerfile`](Dockerfile) in this repository will download the Hugo Extended binary and its dependencies, and start a live testing server. + +Simply run `yarn serve:docker` or build and run manually with: ```bash docker build -t jarv.is:develop -f Dockerfile . docker run -v $(pwd):/src -p 1313:1313 jarv.is:develop ``` -...then open [http://localhost:1313/](http://localhost:1313/). Pages will live-refresh when source files are changed. +...then open [http://localhost:1313/](http://localhost:1313/) as above. ## Licenses diff --git a/config.toml b/config.toml index 64eaaa3c..28fd855e 100644 --- a/config.toml +++ b/config.toml @@ -13,6 +13,7 @@ disableKinds = ["taxonomy", "taxonomyTerm"] pygmentsUseClasses = true pygmentsCodeFences = true +pygmentsCodeFencesGuessSyntax = false enableRobotsTXT = true diff --git a/netlify.toml b/netlify.toml index 4ca5683c..af68c430 100644 --- a/netlify.toml +++ b/netlify.toml @@ -4,8 +4,8 @@ [build.environment] NODE_VERSION = "12.13.1" - NPM_VERSION = "6.13.2" - YARN_VERSION = "1.21.0" + NPM_VERSION = "6.13.3" + YARN_VERSION = "1.21.1" YARN_FLAGS = "--no-ignore-optional --frozen-lockfile" # Ensure *only* Pretty URLs are enabled, even though this is already set up in diff --git a/package.json b/package.json index 47b9b02a..a8d67f37 100644 --- a/package.json +++ b/package.json @@ -52,7 +52,7 @@ "stylelint-scss": "~3.13.0" }, "engines": { - "node": ">=10.0.0", + "node": ">=12.13.0", "npm": "^6.13.0", "yarn": "^1.19.2" },