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:
19
README.md
19
README.md
@@ -1,6 +1,7 @@
|
|||||||
# 🏡 [jarv.is](https://jarv.is/)
|
# 🏡 [jarv.is](https://jarv.is/)
|
||||||
|
|
||||||
[](https://app.netlify.com/sites/jakejarvis/deploys) [](https://jarv.is/) [](https://github.com/gohugoio/hugo) [](https://github.com/jakejarvis/jarv.is) [](LICENSE.md) [](https://twitter.com/intent/user?screen_name=jakejarvis)
|
[](https://app.netlify.com/sites/jakejarvis/deploys) [](https://jarv.is/) [](https://github.com/gohugoio/hugo) [](https://github.com/jakejarvis/jarv.is/pulls?q=is%3Apr+label%3Adependencies) [](https://github.com/jakejarvis/jarv.is) [](LICENSE.md) [](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
|
||||||
|
@@ -13,6 +13,7 @@ disableKinds = ["taxonomy", "taxonomyTerm"]
|
|||||||
|
|
||||||
pygmentsUseClasses = true
|
pygmentsUseClasses = true
|
||||||
pygmentsCodeFences = true
|
pygmentsCodeFences = true
|
||||||
|
pygmentsCodeFencesGuessSyntax = false
|
||||||
|
|
||||||
enableRobotsTXT = true
|
enableRobotsTXT = true
|
||||||
|
|
||||||
|
@@ -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
|
||||||
|
@@ -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"
|
||||||
},
|
},
|
||||||
|
Reference in New Issue
Block a user