jake/jarv.is
1
Fork 0
mirror of https://github.com/jakejarvis/jarv.is.git synced 2025-10-28 19:05:50 -04:00
Code Issues Activity

Update README.md

Browse Source 
[skip ci]
This commit is contained in:
Jake Jarvis
2020-07-05 10:27:20 -04:00
committed by GitHub
parent 426e7d91f1
commit c8c7fe131a
1 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -1,4 +1,10 @@
# 🏡  [jarv.is](https://jarv.is/)  [![Netlify](https://img.shields.io/netlify/a7403a53-fd9d-44c0-a708-a84d9fc1454d?logo=netlify&logoColor=white)](https://app.netlify.com/sites/jakejarvis/deploys) [![Hugo v0.68.3](https://img.shields.io/badge/hugo-v0.68.3-ff4088?logo=hugo&logoColor=white)](https://github.com/gohugoio/hugo) [![Licensed under CC-BY-4.0](https://img.shields.io/github/license/jakejarvis/jarv.is?color=fb7828&logo=creative-commons&logoColor=white)](LICENSE.md) [![Twitter Follow](https://img.shields.io/twitter/follow/jakejarvis?label=Follow&style=social)](https://twitter.com/intent/user?screen_name=jakejarvis) # 🏡  [jarv.is](https://jarv.is/)
[![Netlify](https://img.shields.io/netlify/a7403a53-fd9d-44c0-a708-a84d9fc1454d?logo=netlify&logoColor=white)](https://app.netlify.com/sites/jakejarvis/deploys)
[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/jakejarvis/jarv.is/CI/main?label=build&logo=github&logoColor=white)](https://github.com/jakejarvis/jarv.is/actions?query=workflow%3ACI+branch%3Amain)
[![Hugo v0.68.3](https://img.shields.io/badge/hugo-0.68.3-ff4088?logo=hugo&logoColor=white)](https://github.com/gohugoio/hugo)
[![Licensed under CC-BY-4.0](https://img.shields.io/badge/license-CC--BY--4.0-fb7828?logo=creative-commons&logoColor=white)](LICENSE.md)
[![GitHub repo size](https://img.shields.io/github/repo-size/jakejarvis/jarv.is?color=009cdf&label=repo%20size&logo=git&logoColor=white)](https://github.com/jakejarvis/jarv.is)
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:
@@ -10,13 +16,13 @@ Personal website of [@jakejarvis](https://github.com/jakejarvis), created and de
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. 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 ## 💾  Running a local testing server
### 🧶 Using Yarn/NPM: ### 🧶  Using Yarn/NPM:
Run `yarn install` ([Yarn must be installed](https://yarnpkg.com/en/docs/install) first, or use `npm install` if you insist) and `yarn start` (or `npm start`), then open [http://localhost:1337/](http://localhost:1337/). Pages will live-refresh when source files are changed. Run `yarn install` ([Yarn must be installed](https://yarnpkg.com/en/docs/install) first, or use `npm install` if you insist) and `yarn start` (or `npm start`), then open [http://localhost:1337/](http://localhost:1337/). Pages will live-refresh when source files are changed.
### 🐳 Using Docker: ### 🐳  Using Docker:
To ensure consistency and compatibility, the [`Dockerfile`](Dockerfile) in this repository will download the correct version of the Hugo Extended binary and its dependencies, and start a live testing server in a temporary container. To ensure consistency and compatibility, the [`Dockerfile`](Dockerfile) in this repository will download the correct version of the Hugo Extended binary and its dependencies, and start a live testing server in a temporary container.
@@ -28,11 +34,11 @@ docker run --rm -v $(pwd):/src -p 1337:1337 $(docker build --no-cache -q .)
Once built, these two methods act identically — simply open [http://localhost:1337/](http://localhost:1337/) as above. Once built, these two methods act identically — simply open [http://localhost:1337/](http://localhost:1337/) as above.
### 🤯 Why does this sound _way_ more complex than it needs to be?! ### 🤯  Why does this sound _way_ more complex than it needs to be?!
[Because it is.](https://www.jvt.me/talks/overengineering-your-personal-website/) [Because it is.](https://www.jvt.me/talks/overengineering-your-personal-website/)
## 📜 Licenses ## 📜  Licenses
![Creative Commons Attribution 4.0 International License](https://raw.githubusercontent.com/creativecommons/cc-cert-core/master/images/cc-by-88x31.png "CC BY") ![Creative Commons Attribution 4.0 International License](https://raw.githubusercontent.com/creativecommons/cc-cert-core/master/images/cc-by-88x31.png "CC BY")
@@ -42,7 +48,7 @@ All original code in this repository (like my [Hugo theme](layouts/)) is publish
External assets include: External assets include:
- [**Twemoji**](https://twemoji.twitter.com/): Copyright (c) 2018 Twitter, Inc. and other contributors. [Licensed under CC-BY-4.0.](https://github.com/twitter/twemoji/blob/v12.1.5/LICENSE-GRAPHICS) - [**Twemoji**](https://twemoji.twitter.com/): Copyright (c) 2020 Twitter, Inc. and other contributors. [Licensed under CC-BY-4.0.](https://github.com/twitter/twemoji/blob/v13.0.0/LICENSE-GRAPHICS)
- [**Inter**](https://rsms.me/inter/): Copyright (c) 2016-2020 The Inter Project Authors. [Licensed under the SIL Open Font License, Version 1.1.](https://github.com/rsms/inter/blob/v3.13/LICENSE.txt) - [**Inter**](https://rsms.me/inter/): Copyright (c) 2016-2020 The Inter Project Authors. [Licensed under the SIL Open Font License, Version 1.1.](https://github.com/rsms/inter/blob/v3.13/LICENSE.txt)
- [**Hack**](https://sourcefoundry.org/hack/): Copyright (c) 2018 Source Foundry Authors. [Licensed under the MIT License.](https://github.com/source-foundry/Hack/blob/v3.003/LICENSE.md) - [**Hack**](https://sourcefoundry.org/hack/): Copyright (c) 2018 Source Foundry Authors. [Licensed under the MIT License.](https://github.com/source-foundry/Hack/blob/v3.003/LICENSE.md)
- [**Comic Neue**](http://comicneue.com/): Copyright (c) 2014 The Comic Neue Project Authors. [Licensed under the SIL Open Font License, Version 1.1.](https://github.com/crozynski/comicneue/blob/v2.5/OFL.txt) - [**Comic Neue**](http://comicneue.com/): Copyright (c) 2014 The Comic Neue Project Authors. [Licensed under the SIL Open Font License, Version 1.1.](https://github.com/crozynski/comicneue/blob/v2.5/OFL.txt)