1
mirror of https://github.com/jakejarvis/jarv.is.git synced 2025-07-21 06:21:17 -04:00

update readme

[skip ci]
This commit is contained in:
2019-12-11 10:52:15 -05:00
parent 1d7ad74da9
commit dc4d46756d
4 changed files with 16 additions and 10 deletions

View File

@@ -1,6 +1,7 @@
# 🏡  [jarv.is](https://jarv.is/) # 🏡  [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: 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/) - [Netlify](https://www.netlify.com/)
- [Commento](https://gitlab.com/commento/commento) - [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 ```bash
docker build -t jarv.is:develop -f Dockerfile . docker build -t jarv.is:develop -f Dockerfile .
docker run -v $(pwd):/src -p 1313:1313 jarv.is:develop 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 ## Licenses

View File

@@ -13,6 +13,7 @@ disableKinds = ["taxonomy", "taxonomyTerm"]
pygmentsUseClasses = true pygmentsUseClasses = true
pygmentsCodeFences = true pygmentsCodeFences = true
pygmentsCodeFencesGuessSyntax = false
enableRobotsTXT = true enableRobotsTXT = true

View File

@@ -4,8 +4,8 @@
[build.environment] [build.environment]
NODE_VERSION = "12.13.1" NODE_VERSION = "12.13.1"
NPM_VERSION = "6.13.2" NPM_VERSION = "6.13.3"
YARN_VERSION = "1.21.0" YARN_VERSION = "1.21.1"
YARN_FLAGS = "--no-ignore-optional --frozen-lockfile" YARN_FLAGS = "--no-ignore-optional --frozen-lockfile"
# Ensure *only* Pretty URLs are enabled, even though this is already set up in # Ensure *only* Pretty URLs are enabled, even though this is already set up in

View File

@@ -52,7 +52,7 @@
"stylelint-scss": "~3.13.0" "stylelint-scss": "~3.13.0"
}, },
"engines": { "engines": {
"node": ">=10.0.0", "node": ">=12.13.0",
"npm": "^6.13.0", "npm": "^6.13.0",
"yarn": "^1.19.2" "yarn": "^1.19.2"
}, },