From 5f30c228485499337440d4bb7d84101bd6d48b8e Mon Sep 17 00:00:00 2001 From: Jake Wiesler Date: Sat, 27 Jun 2020 10:44:07 -0400 Subject: [PATCH 1/5] add prettier Prettier has been added as a dev dependency along with a few other tools that run prettier on staged files before committing them. This prevents any file from being committed that hasn't gone through the project's formatting. Check the prettier.config.js file for details on how we format files. --- .prettierignore | 10 +- CONTRIBUTING.md | 15 +- README.md | 102 ++- assets/js/index.js | 10 +- assets/scss/_main.scss | 13 +- assets/scss/pages/about.scss | 2 +- assets/scss/pages/posts.scss | 6 +- assets/scss/pages/tags.scss | 7 +- assets/scss/partials/_colors.scss | 8 +- .../partials/_github-syntax-highlighting.scss | 7 +- assets/scss/partials/_nav.scss | 3 +- assets/scss/partials/_normalize.scss | 4 +- assets/scss/partials/_reset.scss | 7 +- assets/scss/partials/_social-icons.scss | 2 +- assets/scss/partials/_typography.scss | 29 +- assets/scss/partials/_vars.scss | 4 +- exampleSite/content/blog/example-post.md | 34 +- exampleSite/content/blog/markdown-syntax.md | 95 +- exampleSite/content/blog/math-typesetting.md | 26 +- exampleSite/content/blog/rich-content.md | 9 +- package.json | 18 +- prettier.config.js | 13 + static/js/table-of-contents.js | 26 +- yarn.lock | 860 ++++++++++++++++++ 24 files changed, 1172 insertions(+), 138 deletions(-) create mode 100644 prettier.config.js create mode 100644 yarn.lock diff --git a/.prettierignore b/.prettierignore index ce52c0f4..9f411305 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,2 +1,10 @@ -content layouts +static + +package.json +public +node_modules + +.DS_Store +logs +*.log diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 992dcda7..2ab1137d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ # Contributing -First off, thank you for your time and effort! This project is not very large and easy to jump into. +First off, thank you for your time and effort! This project is not very large +and easy to jump into. ## Development stack @@ -28,14 +29,17 @@ There are 3 npm scripts that can be used for development purposes: yarn develop ``` -This command will start a hugo webserver and serve the `exampleSite`. This works well because the example site uses `hugo-theme-codex`, so any changes -we make to the codebase can be viewed in real time. +This command will start a hugo webserver and serve the `exampleSite`. This works +well because the example site uses `hugo-theme-codex`, so any changes we make to +the codebase can be viewed in real time. ```bash yarn watch:assets ``` -If you are working with `js` or `css` you will probably want to run this command in a separate tab from `yarn develop` so that any changes to assets like javascript and css will trigger a re-build by `gulp``. +If you are working with `js` or `css` you will probably want to run this command +in a separate tab from `yarn develop` so that any changes to assets like +javascript and css will trigger a re-build by `gulp``. ```bash yarn build:assets @@ -45,7 +49,8 @@ Triggers a one-time build of the static directory. ## Questions -If you have any questions feel free to reach out to me directly. Best ways to contact me: +If you have any questions feel free to reach out to me directly. Best ways to +contact me: - Twitter: https://twitter.com/jakewies - Email: jakewiesler@gmail.com diff --git a/README.md b/README.md index b2d7072d..bd95507c 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,11 @@ A minimal blog theme built for [Hugo](https://gohugo.io/) 🍜 Hugo **extended version** (for Sass/SCSS support). -For macOS users, the extended version is installed by default if you use `homebrew`. +For macOS users, the extended version is installed by default if you use +`homebrew`. For Windows users, you can install with `choco`: + ``` choco install hugo-extended -confirm ``` @@ -27,19 +29,24 @@ At the root of your Hugo project, run: git submodule add https://github.com/jakewies/hugo-theme-codex.git themes/codex ``` -Next, copy the contents of the [default `config.toml`](https://github.com/jakewies/hugo-theme-codex/blob/master/exampleSite/config.toml) to your site's `config.toml`. Make sure to read all the comments, as there a few nuances with Hugo themes that require some changes to that file. +Next, copy the contents of the +[default `config.toml`](https://github.com/jakewies/hugo-theme-codex/blob/master/exampleSite/config.toml) +to your site's `config.toml`. Make sure to read all the comments, as there a few +nuances with Hugo themes that require some changes to that file. Finally, run: ``` -hugo server -D +hugo server -D ``` -**Note: If you are seeing a blank page it is probably because you have nothing in your `content/` directory. Read on to fix that.** +**Note: If you are seeing a blank page it is probably because you have nothing +in your `content/` directory. Read on to fix that.** ### Configuring the Home Page -The site's home page can be configured by creating a `content/_index.md` file. This file can use the following frontmatter: +The site's home page can be configured by creating a `content/_index.md` file. +This file can use the following frontmatter: ```md --- @@ -49,11 +56,15 @@ handle: "hugo-theme-codex" --- ``` -If you would rather override the about page's layout with your own, you can do so by creating a `layouts/index.html`. You can find the `index.html` file that `hugo-theme-codex` uses [here](https://github.com/jakewies/hugo-theme-codex/blob/master/layouts/index.html). +If you would rather override the about page's layout with your own, you can do +so by creating a `layouts/index.html`. You can find the `index.html` file that +`hugo-theme-codex` uses +[here](https://github.com/jakewies/hugo-theme-codex/blob/master/layouts/index.html). ### Configuring Social Icons -Social Icons are optional. To show any of these icons, just provide the value in the `[params]` section of `config.toml`. +Social Icons are optional. To show any of these icons, just provide the value in +the `[params]` section of `config.toml`. ```toml # config.toml @@ -66,65 +77,94 @@ Social Icons are optional. To show any of these icons, just provide the value in iconTitles = ["Twitter", "GitHub"] ``` -If any of these options are given, `hugo-theme-codex` will render the social icon in the footer, using the order specified in `iconTitles`. +If any of these options are given, `hugo-theme-codex` will render the social +icon in the footer, using the order specified in `iconTitles`. -See the contents of the [example site](https://github.com/jakewies/hugo-theme-codex/tree/master/exampleSite) for more details. +See the contents of the +[example site](https://github.com/jakewies/hugo-theme-codex/tree/master/exampleSite) +for more details. You can also create additional social icons by: -1. Adding your own SVGs in `static/images/social/`, for example `static/images/social/reddit.svg`. + +1. Adding your own SVGs in `static/images/social/`, for example + `static/images/social/reddit.svg`. 2. Modifying your site's config as follows: + ```toml [params] # ... reddit = "" - + iconTitles = [ "...", "Reddit"] ``` -Make sure that the icon title must match the icon's file name. If the title contains more than one word, say "My Awesome Site", -you can use dash "-" for the icon name: `my-awesome-site.svg`. +Make sure that the icon title must match the icon's file name. If the title +contains more than one word, say "My Awesome Site", you can use dash "-" for the +icon name: `my-awesome-site.svg`. ### Creating a blog post -You can create a new blog post page by going to the root of your project and typing: +You can create a new blog post page by going to the root of your project and +typing: ``` hugo new blog/:blog-post.md ``` -Where `:blog-post.md` is the name of the file of your new post. +Where `:blog-post.md` is the name of the file of your new post. -This will execute the theme's `blog` archetype to create a new markdown file in `contents/blog/:blog-post.md` with the following frontmatter: +This will execute the theme's `blog` archetype to create a new markdown file in +`contents/blog/:blog-post.md` with the following frontmatter: ```md # Default post frontmatter: # The title of your post. Default value is generated + # From the markdown filename + title: "{{ replace .TranslationBaseName "-" " " | title }}" + # The date the post was created + date: {{ .Date }} + # The post filename + slug: "" + # Post description used for seo + description: "" + # Post keywords used for seo + keywords: [] + # If true, the blog post will not be included in static build + draft: true + # Categorize your post with tags + tags: [] + # Uses math typesetting + math: false + # Includes a table of contents on screens >1024px + toc: false ``` -The frontmatter above is the default for a new post, but all values can be changed. +The frontmatter above is the default for a new post, but all values can be +changed. ### Adding a new section menu In your site's `config.toml`, add a new menu definition for say, "photos": + ```toml # config.toml @@ -135,12 +175,13 @@ In your site's `config.toml`, add a new menu definition for say, "photos": url = "/photos" ``` -Then, put your posts under "content/photos". +Then, put your posts under "content/photos". ### Custom styling -In your site's folder, create `assets/scss/custom.scss` and put your custom styling there. For example, the snippet below -changes the dot's color on your About page to blue: +In your site's folder, create `assets/scss/custom.scss` and put your custom +styling there. For example, the snippet below changes the dot's color on your +About page to blue: ```scss // custom.scss @@ -166,23 +207,31 @@ You can even use Hugo variables/params in your custom styles too! ### Tags -Right now `hugo-theme-codex` uses the `tags` taxonomy for blog posts. You can view all the blog posts of a given tag by going to `/tags/:tag-name`, where `:tag-name` is the name of your tag. +Right now `hugo-theme-codex` uses the `tags` taxonomy for blog posts. You can +view all the blog posts of a given tag by going to `/tags/:tag-name`, where +`:tag-name` is the name of your tag. ### Favicon -To update favicon of the site, replace the one in `static/favicon.ico` with your own. +To update favicon of the site, replace the one in `static/favicon.ico` with your +own. ## Contributing -Check out the [CONTRIBUTORS.md file](https://github.com/jakewies/hugo-theme-codex/blob/master/CONTRIBUTING.md) for more info on how you can contribute! +Check out the +[CONTRIBUTORS.md file](https://github.com/jakewies/hugo-theme-codex/blob/master/CONTRIBUTING.md) +for more info on how you can contribute! ## Contributors ✨ + [![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-) + -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): +Thanks goes to these wonderful people +([emoji key](https://allcontributors.org/docs/en/emoji-key)): @@ -201,6 +250,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d + -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! +This project follows the +[all-contributors](https://github.com/all-contributors/all-contributors) +specification. Contributions of any kind welcome! diff --git a/assets/js/index.js b/assets/js/index.js index 66edd2e7..3c46c674 100644 --- a/assets/js/index.js +++ b/assets/js/index.js @@ -3,8 +3,8 @@ */ function toggleMobileNavState() { - const body = document.querySelector("body"); - body.classList.toggle("nav--active"); + const body = document.querySelector("body") + body.classList.toggle("nav--active") } /* @@ -12,8 +12,8 @@ function toggleMobileNavState() { */ function initBurger() { - const burger = document.querySelector(".burger"); - burger.addEventListener("click", toggleMobileNavState); + const burger = document.querySelector(".burger") + burger.addEventListener("click", toggleMobileNavState) } -initBurger(); +initBurger() diff --git a/assets/scss/_main.scss b/assets/scss/_main.scss index ba7efc10..3b6a5186 100644 --- a/assets/scss/_main.scss +++ b/assets/scss/_main.scss @@ -1,9 +1,9 @@ -@import 'partials/normalize'; -@import 'partials/vars'; -@import 'partials/reset'; -@import 'partials/typography'; -@import 'partials/nav'; -@import 'partials/social-icons'; +@import "partials/normalize"; +@import "partials/vars"; +@import "partials/reset"; +@import "partials/typography"; +@import "partials/nav"; +@import "partials/social-icons"; body.nav--active { overflow: hidden; @@ -12,7 +12,6 @@ body.nav--active { main { padding: 3rem 1.5rem; - @media screen and (min-width: $medium) { padding-left: calc(1.5rem + #{$navWidth}); } diff --git a/assets/scss/pages/about.scss b/assets/scss/pages/about.scss index 6420ab28..37546a1b 100644 --- a/assets/scss/pages/about.scss +++ b/assets/scss/pages/about.scss @@ -1,4 +1,4 @@ -@import '../main'; +@import "../main"; .splash-container { height: 100%; diff --git a/assets/scss/pages/posts.scss b/assets/scss/pages/posts.scss index 8b06dd1d..4a89154a 100644 --- a/assets/scss/pages/posts.scss +++ b/assets/scss/pages/posts.scss @@ -1,5 +1,5 @@ -@import '../main'; -@import '../partials/post-list'; +@import "../main"; +@import "../partials/post-list"; .tags__list { list-style: none; @@ -40,7 +40,7 @@ font-size: 0.9rem; &::before { - content: '#'; + content: "#"; font-size: 0.7rem; padding-right: 1px; } diff --git a/assets/scss/pages/tags.scss b/assets/scss/pages/tags.scss index 31c2d7f5..3cc181fa 100644 --- a/assets/scss/pages/tags.scss +++ b/assets/scss/pages/tags.scss @@ -1,12 +1,13 @@ -@import '../main'; -@import '../partials/post-list'; +@import "../main"; +@import "../partials/post-list"; .tag__header { align-items: baseline; display: flex; margin: 0 auto 3rem; - a, .separator { + a, + .separator { color: $grey; font-size: 1.5rem; } diff --git a/assets/scss/partials/_colors.scss b/assets/scss/partials/_colors.scss index bfe1b52b..351903cc 100644 --- a/assets/scss/partials/_colors.scss +++ b/assets/scss/partials/_colors.scss @@ -1,7 +1,7 @@ $black: #111; -$lightGrey: #F7F7F7; -$greyTableBorder: #EEEEEE; -$grey: #9B9B9B; +$lightGrey: #f7f7f7; +$greyTableBorder: #eeeeee; +$grey: #9b9b9b; $darkGrey: #717171; $white: #fff; -$primary: #9013FE; +$primary: #9013fe; diff --git a/assets/scss/partials/_github-syntax-highlighting.scss b/assets/scss/partials/_github-syntax-highlighting.scss index b7c7a7fd..c61ab553 100644 --- a/assets/scss/partials/_github-syntax-highlighting.scss +++ b/assets/scss/partials/_github-syntax-highlighting.scss @@ -77,7 +77,7 @@ pre[class*="language-"] { color: #032f62; } -.language-jsx span[class="comment"]{ +.language-jsx span[class="comment"] { color: pink; } @@ -91,7 +91,10 @@ pre[class*="language-"] { } .language-html .token.tag .token.attr-value, -.language-html .token.tag .token.attr-value .token.punctuation:not(:first-child) { +.language-html + .token.tag + .token.attr-value + .token.punctuation:not(:first-child) { color: #032f62; } diff --git a/assets/scss/partials/_nav.scss b/assets/scss/partials/_nav.scss index 7a4f8482..4e302042 100644 --- a/assets/scss/partials/_nav.scss +++ b/assets/scss/partials/_nav.scss @@ -1,4 +1,4 @@ -@import 'burger'; +@import "burger"; .nav { font-size: 16px; @@ -35,7 +35,6 @@ width: auto; } - @media screen and (max-width: $medium - 1) { transform: translateY(-25px); opacity: 0; diff --git a/assets/scss/partials/_normalize.scss b/assets/scss/partials/_normalize.scss index 2278ddc8..ff5581f2 100644 --- a/assets/scss/partials/_normalize.scss +++ b/assets/scss/partials/_normalize.scss @@ -6,8 +6,8 @@ button[type="submit"] { } input, -input[type=text], -input[type=email] { +input[type="text"], +input[type="email"] { -webkit-appearance: none; -moz-appearance: none; appearance: none; diff --git a/assets/scss/partials/_reset.scss b/assets/scss/partials/_reset.scss index 7bf1d099..1c298ff9 100644 --- a/assets/scss/partials/_reset.scss +++ b/assets/scss/partials/_reset.scss @@ -1,6 +1,7 @@ @import "colors"; -html, body { +html, +body { background-color: $white; color: $black; height: 100%; @@ -10,7 +11,9 @@ html { box-sizing: border-box; } -*, *:before, *:after { +*, +*:before, +*:after { padding: 0; margin: 0; box-sizing: inherit; diff --git a/assets/scss/partials/_social-icons.scss b/assets/scss/partials/_social-icons.scss index 9e621b68..0e705b5b 100644 --- a/assets/scss/partials/_social-icons.scss +++ b/assets/scss/partials/_social-icons.scss @@ -8,7 +8,7 @@ height: 1.2rem; background-size: contain; background-repeat: no-repeat; - + &:not(:last-child) { margin-right: 2em; } diff --git a/assets/scss/partials/_typography.scss b/assets/scss/partials/_typography.scss index 367cb580..e9fb87c9 100644 --- a/assets/scss/partials/_typography.scss +++ b/assets/scss/partials/_typography.scss @@ -7,7 +7,8 @@ $scale: 1.414; $leading: $baseLineHeight * 1rem; html { - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, + Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif; -webkit-font-smoothing: antialiased; font-size: 95%; @@ -20,7 +21,12 @@ html { } } -h1, h2, h3, h4, h5, h6 { +h1, +h2, +h3, +h4, +h5, +h6 { margin-top: $leading; margin-bottom: 0; line-height: $leading; @@ -74,32 +80,31 @@ ol { blockquote { &::before { position: absolute; - content: '\201C'; + content: "\201C"; font-size: 6em; - font-family: 'Roboto', serif; - margin-top: 0.10em;; + font-family: "Roboto", serif; + margin-top: 0.1em; margin-left: -0.2em; - + z-index: -1; color: darken($white, 7%); } - + margin-top: $leading; margin-bottom: $leading; line-height: $leading; color: $black; - + cite { &::before { - content: "— " + content: "— "; } - + font-style: italic; - font-size: .95em; + font-size: 0.95em; color: $darkGrey; } - } pre { diff --git a/assets/scss/partials/_vars.scss b/assets/scss/partials/_vars.scss index 4407877d..b7306158 100644 --- a/assets/scss/partials/_vars.scss +++ b/assets/scss/partials/_vars.scss @@ -1,5 +1,5 @@ -@import '_colors'; -@import '_screenSizes'; +@import "_colors"; +@import "_screenSizes"; $navWidth: 100px; $meatWidth: 28px; diff --git a/exampleSite/content/blog/example-post.md b/exampleSite/content/blog/example-post.md index 5f8b62b3..7cde4b7c 100644 --- a/exampleSite/content/blog/example-post.md +++ b/exampleSite/content/blog/example-post.md @@ -12,12 +12,40 @@ toc: true ## The standard Lorem Ipsum passage -"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum." +"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor +incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis +nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. +Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu +fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in +culpa qui officia deserunt mollit anim id est laborum." ## written by Cicero in 45 BC -"Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?" +"Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium +doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore +veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam +voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia +consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque +porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci +velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore +magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum +exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi +consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit +esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo +voluptas nulla pariatur?" ## 1914 translation by H. Rackham -"But I must explain to you how all this mistaken idea of denouncing pleasure and praising pain was born and I will give you a complete account of the system, and expound the actual teachings of the great explorer of the truth, the master-builder of human happiness. No one rejects, dislikes, or avoids pleasure itself, because it is pleasure, but because those who do not know how to pursue pleasure rationally encounter consequences that are extremely painful. Nor again is there anyone who loves or pursues or desires to obtain pain of itself, because it is pain, but because occasionally circumstances occur in which toil and pain can procure him some great pleasure. To take a trivial example, which of us ever undertakes laborious physical exercise, except to obtain some advantage from it? But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?" +"But I must explain to you how all this mistaken idea of denouncing pleasure and +praising pain was born and I will give you a complete account of the system, and +expound the actual teachings of the great explorer of the truth, the +master-builder of human happiness. No one rejects, dislikes, or avoids pleasure +itself, because it is pleasure, but because those who do not know how to pursue +pleasure rationally encounter consequences that are extremely painful. Nor again +is there anyone who loves or pursues or desires to obtain pain of itself, +because it is pain, but because occasionally circumstances occur in which toil +and pain can procure him some great pleasure. To take a trivial example, which +of us ever undertakes laborious physical exercise, except to obtain some +advantage from it? But who has any right to find fault with a man who chooses to +enjoy a pleasure that has no annoying consequences, or one who avoids a pain +that produces no resultant pleasure?" diff --git a/exampleSite/content/blog/markdown-syntax.md b/exampleSite/content/blog/markdown-syntax.md index 39b0b6d9..d1523082 100644 --- a/exampleSite/content/blog/markdown-syntax.md +++ b/exampleSite/content/blog/markdown-syntax.md @@ -2,7 +2,9 @@ title: "Markdown Syntax Guide" date: 2020-06-05 slug: "markdown-syntax-guide" -description: "Sample article showcasing basic Markdown syntax and formatting for HTML elements" +description: + "Sample article showcasing basic Markdown syntax and formatting for HTML + elements" keywords: ["gohugo", "hugo", "go", "blog"] draft: false tags: ["markdown", "css", "html", "themes"] @@ -10,57 +12,79 @@ math: false toc: false --- -This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme. +This article offers a sample of basic Markdown syntax that can be used in Hugo +content files, also it shows whether basic HTML elements are decorated with CSS +in a Hugo theme. + ## Headings -The following HTML `

`—`

` elements represent six levels of section headings. `

` is the highest section level while `

` is the lowest. +The following HTML `

`—`

` elements represent six levels of section +headings. `

` is the highest section level while `

` is the lowest. # H1 + ## H2 + ### H3 + #### H4 + ##### H5 + ###### H6 ## Paragraph -Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat. +Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, +voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma +dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as +cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin +porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? +Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit +ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda +veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore +eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata +tiustia prat. -Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat. +Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne +sapicia is sinveli squiatum, core et que aut hariosam ex eat. ## Blockquotes -The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a `footer` or `cite` element, and optionally with in-line changes such as annotations and abbreviations. +The blockquote element represents content that is quoted from another source, +optionally with a citation which must be within a `footer` or `cite` element, +and optionally with in-line changes such as annotations and abbreviations. #### Blockquote without attribution -> Tiam, ad mint andaepu dandae nostion secatur sequo quae. -> **Note** that you can use *Markdown syntax* within a blockquote. +> Tiam, ad mint andaepu dandae nostion secatur sequo quae. **Note** that you can +> use _Markdown syntax_ within a blockquote. #### Blockquote with attribution -> Simplicity is the ultimate sophistication. -> Leonardo da Vinci[^1] - -[^1]: The above quote is often attributed to Leonardo da Vinci but there is no concrete evidence to support this. +> Simplicity is the ultimate sophistication. Leonardo da Vinci[^1] +[^1]: + The above quote is often attributed to Leonardo da Vinci but there is no + concrete evidence to support this. ## Tables -Tables aren't part of the core Markdown spec, but Hugo supports supports them out-of-the-box. +Tables aren't part of the core Markdown spec, but Hugo supports supports them +out-of-the-box. - Name | Age ---------|------ - Bob | 27 - Alice | 23 +| Name | Age | +| ----- | --- | +| Bob | 27 | +| Alice | 23 | #### Inline Markdown within tables -| Inline    | Markdown    | In    | Table | -| ---------- | --------- | ----------------- | ---------- | -| *italics* | **bold** | ~~strikethrough~~    | `code` | +| Inline    | Markdown    | In    | Table | +| ------------------------ | -------------------------- | ----------------------------------- | ------ | +| _italics_ | **bold** | ~~strikethrough~~    | `code` | ## Code Blocks @@ -79,6 +103,7 @@ html ``` + #### Code block indented with four spaces @@ -93,16 +118,17 @@ html #### Code block with Hugo's internal highlight shortcode + ```html - - - Example HTML5 Document - - -

Test

- + + + Example HTML5 Document + + +

Test

+ ``` @@ -116,13 +142,14 @@ html #### Unordered List -* List item -* Another item -* And another item +- List item +- Another item +- And another item #### Nested list -* Item +- Item + 1. First Sub-item 2. Second Sub-item @@ -134,6 +161,8 @@ H2O Xn + Yn = Zn -Press CTRL+ALT+Delete to end the session. +Press CTRL+ALT+Delete to end the +session. -Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures. +Most salamanders are nocturnal, and hunt for insects, worms, and +other small creatures. diff --git a/exampleSite/content/blog/math-typesetting.md b/exampleSite/content/blog/math-typesetting.md index d7ce7711..aec48211 100644 --- a/exampleSite/content/blog/math-typesetting.md +++ b/exampleSite/content/blog/math-typesetting.md @@ -10,26 +10,34 @@ math: true toc: false --- -Mathematical notation in a Hugo project can be enabled by using third party JavaScript libraries. +Mathematical notation in a Hugo project can be enabled by using third party +JavaScript libraries. + In this example we will be using [KaTeX](https://katex.org/) - Create a partial under `/layouts/partials/math.html` -- Within this partial reference the [Auto-render Extension](https://katex.org/docs/autorender.html) or host these scripts locally. -- Include the partial in your templates like so: +- Within this partial reference the + [Auto-render Extension](https://katex.org/docs/autorender.html) or host these + scripts locally. +- Include the partial in your templates like so: ``` {{ if or .Params.math .Site.Params.math }} {{ partial "math.html" . }} {{ end }} -``` -- To enable KaTex globally set the parameter `math` to `true` in a project's configuration -- To enable KaTex on a per page basis include the parameter `math: true` in content files. +``` + +- To enable KaTex globally set the parameter `math` to `true` in a project's + configuration +- To enable KaTex on a per page basis include the parameter `math: true` in + content files. + +**Note:** Use the online reference of +[Supported TeX Functions](https://katex.org/docs/supported.html) +{{< math.inline >}} {{ if or .Page.Params.math .Site.Params.math }} -**Note:** Use the online reference of [Supported TeX Functions](https://katex.org/docs/supported.html) -{{< math.inline >}} -{{ if or .Page.Params.math .Site.Params.math }} diff --git a/exampleSite/content/blog/rich-content.md b/exampleSite/content/blog/rich-content.md index c69a34bd..741d3832 100644 --- a/exampleSite/content/blog/rich-content.md +++ b/exampleSite/content/blog/rich-content.md @@ -10,23 +10,24 @@ math: false toc: false --- -Hugo ships with several [Built-in Shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugo-s-built-in-shortcodes) for rich content, along with a [Privacy Config](https://gohugo.io/about/hugo-and-gdpr/) and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds. +Hugo ships with several +[Built-in Shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugo-s-built-in-shortcodes) +for rich content, along with a +[Privacy Config](https://gohugo.io/about/hugo-and-gdpr/) and a set of Simple +Shortcodes that enable static and no-JS versions of various social media embeds. ## Instagram Simple Shortcode {{< instagram_simple BGvuInzyFAe hidecaption >}} - ## YouTube Privacy Enhanced Shortcode {{< youtube ZJthWmvUzzc >}} - ## Twitter Simple Shortcode {{< tweet 1085870671291310081 >}} - ## Vimeo Simple Shortcode {{< vimeo_simple 48912912 >}} diff --git a/package.json b/package.json index b041c311..24d8933e 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,18 @@ "description": "A minimal blog theme for Hugo", "license": "MIT", "scripts": { - "develop": "hugo server -s ./exampleSite/" + "develop": "hugo server -s ./exampleSite/", + "format": "prettier ./ --write" + }, + "husky": { + "hooks": { + "pre-commit": "lint-staged" + } + }, + "devDependencies": { + "husky": "^4.2.5", + "lint-staged": ">=10", + "prettier": "^2.0.5" }, "browserslist": [ "last 2 version", @@ -17,5 +28,8 @@ "hugo", "blog", "go" - ] + ], + "lint-staged": { + "*.{js,css,scss,md}": "prettier --write" + } } diff --git a/prettier.config.js b/prettier.config.js new file mode 100644 index 00000000..7a9bf1c2 --- /dev/null +++ b/prettier.config.js @@ -0,0 +1,13 @@ +module.exports = { + arrowParens: "avoid", + bracketSpacing: false, + endOfLine: "lf", + htmlWhitespaceSensitivity: "css", + printWidth: 80, + proseWrap: "always", + semi: false, + singleQuote: false, + tabWidth: 2, + trailingComma: "all", + useTabs: false, +} diff --git a/static/js/table-of-contents.js b/static/js/table-of-contents.js index 911adbf6..aaf0ca62 100644 --- a/static/js/table-of-contents.js +++ b/static/js/table-of-contents.js @@ -1,17 +1,23 @@ -window.addEventListener('DOMContentLoaded', () => { +window.addEventListener("DOMContentLoaded", () => { const observer = new IntersectionObserver(entries => { entries.forEach(entry => { - const id = entry.target.getAttribute('id'); + const id = entry.target.getAttribute("id") if (entry.intersectionRatio > 0) { - document.querySelector(`#TableOfContents ul li a[href="#${id}"]`).classList.add('active'); + document + .querySelector(`#TableOfContents ul li a[href="#${id}"]`) + .classList.add("active") } else { - document.querySelector(`#TableOfContents ul li a[href="#${id}"]`).classList.remove('active'); + document + .querySelector(`#TableOfContents ul li a[href="#${id}"]`) + .classList.remove("active") } - }); - }); + }) + }) // Track all headers that have an `id` applied - document.querySelectorAll('article h3[id], article h2[id]').forEach((section) => { - observer.observe(section); - }); -}); + document + .querySelectorAll("article h3[id], article h2[id]") + .forEach(section => { + observer.observe(section) + }) +}) diff --git a/yarn.lock b/yarn.lock new file mode 100644 index 00000000..2e56735b --- /dev/null +++ b/yarn.lock @@ -0,0 +1,860 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@babel/code-frame@^7.0.0": + version "7.10.3" + resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.10.3.tgz#324bcfd8d35cd3d47dae18cde63d752086435e9a" + integrity sha512-fDx9eNW0qz0WkUeqL6tXEXzVlPh6Y5aCDEZesl0xBGA8ndRukX91Uk44ZqnkECp01NAZUdCAl+aiQNGi0k88Eg== + dependencies: + "@babel/highlight" "^7.10.3" + +"@babel/helper-validator-identifier@^7.10.3": + version "7.10.3" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.10.3.tgz#60d9847f98c4cea1b279e005fdb7c28be5412d15" + integrity sha512-bU8JvtlYpJSBPuj1VUmKpFGaDZuLxASky3LhaKj3bmpSTY6VWooSM8msk+Z0CZoErFye2tlABF6yDkT3FOPAXw== + +"@babel/highlight@^7.10.3": + version "7.10.3" + resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.10.3.tgz#c633bb34adf07c5c13156692f5922c81ec53f28d" + integrity sha512-Ih9B/u7AtgEnySE2L2F0Xm0GaM729XqqLfHkalTsbjXGyqmf/6M0Cu0WpvqueUlW+xk88BHw9Nkpj49naU+vWw== + dependencies: + "@babel/helper-validator-identifier" "^7.10.3" + chalk "^2.0.0" + js-tokens "^4.0.0" + +"@types/color-name@^1.1.1": + version "1.1.1" + resolved "https://registry.yarnpkg.com/@types/color-name/-/color-name-1.1.1.tgz#1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0" + integrity sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ== + +"@types/minimatch@^3.0.3": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d" + integrity sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA== + +"@types/parse-json@^4.0.0": + version "4.0.0" + resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.0.tgz#2f8bb441434d163b35fb8ffdccd7138927ffb8c0" + integrity sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA== + +aggregate-error@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/aggregate-error/-/aggregate-error-3.0.1.tgz#db2fe7246e536f40d9b5442a39e117d7dd6a24e0" + integrity sha512-quoaXsZ9/BLNae5yiNoUz+Nhkwz83GhWwtYFglcjEQB2NDHCIpApbqXxIFnm4Pq/Nvhrsq5sYJFyohrrxnTGAA== + dependencies: + clean-stack "^2.0.0" + indent-string "^4.0.0" + +ansi-colors@^3.2.1: + version "3.2.4" + resolved "https://registry.yarnpkg.com/ansi-colors/-/ansi-colors-3.2.4.tgz#e3a3da4bfbae6c86a9c285625de124a234026fbf" + integrity sha512-hHUXGagefjN2iRrID63xckIvotOXOojhQKWIPUZ4mNUZ9nLZW+7FMNoE1lOkEhNWYsx/7ysGIuJYCiMAA9FnrA== + +ansi-escapes@^4.3.0: + version "4.3.1" + resolved "https://registry.yarnpkg.com/ansi-escapes/-/ansi-escapes-4.3.1.tgz#a5c47cc43181f1f38ffd7076837700d395522a61" + integrity sha512-JWF7ocqNrp8u9oqpgV+wH5ftbt+cfvv+PTjOvKLT3AdYly/LmORARfEVT1iyjwN+4MqE5UmVKoAdIBqeoCHgLA== + dependencies: + type-fest "^0.11.0" + +ansi-regex@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.0.tgz#388539f55179bf39339c81af30a654d69f87cb75" + integrity sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg== + +ansi-styles@^3.2.1: + version "3.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" + integrity sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA== + dependencies: + color-convert "^1.9.0" + +ansi-styles@^4.0.0, ansi-styles@^4.1.0: + version "4.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.2.1.tgz#90ae75c424d008d2624c5bf29ead3177ebfcf359" + integrity sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA== + dependencies: + "@types/color-name" "^1.1.1" + color-convert "^2.0.1" + +array-differ@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/array-differ/-/array-differ-3.0.0.tgz#3cbb3d0f316810eafcc47624734237d6aee4ae6b" + integrity sha512-THtfYS6KtME/yIAhKjZ2ul7XI96lQGHRputJQHO80LAWQnuGP4iCIN8vdMRboGbIEYBwU33q8Tch1os2+X0kMg== + +array-union@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/array-union/-/array-union-2.1.0.tgz#b798420adbeb1de828d84acd8a2e23d3efe85e8d" + integrity sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw== + +arrify@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/arrify/-/arrify-2.0.1.tgz#c9655e9331e0abcd588d2a7cad7e9956f66701fa" + integrity sha512-3duEwti880xqi4eAMN8AyR4a0ByT90zoYdLlevfrvU43vb0YZwZVfxOgxWrLXXXpyugL0hNZc9G6BiB5B3nUug== + +astral-regex@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/astral-regex/-/astral-regex-2.0.0.tgz#483143c567aeed4785759c0865786dc77d7d2e31" + integrity sha512-Z7tMw1ytTXt5jqMcOP+OQteU1VuNK9Y02uuJtKQ1Sv69jXQKKg5cibLwGJow8yzZP+eAc18EmLGPal0bp36rvQ== + +balanced-match@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/balanced-match/-/balanced-match-1.0.0.tgz#89b4d199ab2bee49de164ea02b89ce462d71b767" + integrity sha1-ibTRmasr7kneFk6gK4nORi1xt2c= + +brace-expansion@^1.1.7: + version "1.1.11" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-1.1.11.tgz#3c7fcbf529d87226f3d2f52b966ff5271eb441dd" + integrity sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA== + dependencies: + balanced-match "^1.0.0" + concat-map "0.0.1" + +braces@^3.0.1: + version "3.0.2" + resolved "https://registry.yarnpkg.com/braces/-/braces-3.0.2.tgz#3454e1a462ee8d599e236df336cd9ea4f8afe107" + integrity sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A== + dependencies: + fill-range "^7.0.1" + +callsites@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/callsites/-/callsites-3.1.0.tgz#b3630abd8943432f54b3f0519238e33cd7df2f73" + integrity sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ== + +chalk@^2.0.0, chalk@^2.4.2: + version "2.4.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424" + integrity sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ== + dependencies: + ansi-styles "^3.2.1" + escape-string-regexp "^1.0.5" + supports-color "^5.3.0" + +chalk@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.0.tgz#4e14870a618d9e2edd97dd8345fd9d9dc315646a" + integrity sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A== + dependencies: + ansi-styles "^4.1.0" + supports-color "^7.1.0" + +ci-info@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-2.0.0.tgz#67a9e964be31a51e15e5010d58e6f12834002f46" + integrity sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ== + +clean-stack@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/clean-stack/-/clean-stack-2.2.0.tgz#ee8472dbb129e727b31e8a10a427dee9dfe4008b" + integrity sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A== + +cli-cursor@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/cli-cursor/-/cli-cursor-3.1.0.tgz#264305a7ae490d1d03bf0c9ba7c925d1753af307" + integrity sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw== + dependencies: + restore-cursor "^3.1.0" + +cli-truncate@2.1.0, cli-truncate@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/cli-truncate/-/cli-truncate-2.1.0.tgz#c39e28bf05edcde5be3b98992a22deed5a2b93c7" + integrity sha512-n8fOixwDD6b/ObinzTrp1ZKFzbgvKZvuz/TvejnLn1aQfC6r52XEx85FmuC+3HI+JM7coBRXUvNqEU2PHVrHpg== + dependencies: + slice-ansi "^3.0.0" + string-width "^4.2.0" + +color-convert@^1.9.0: + version "1.9.3" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8" + integrity sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg== + dependencies: + color-name "1.1.3" + +color-convert@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" + integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== + dependencies: + color-name "~1.1.4" + +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" + integrity sha1-p9BVi9icQveV3UIyj3QIMcpTvCU= + +color-name@~1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" + integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== + +commander@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/commander/-/commander-5.1.0.tgz#46abbd1652f8e059bddaef99bbdcb2ad9cf179ae" + integrity sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg== + +compare-versions@^3.6.0: + version "3.6.0" + resolved "https://registry.yarnpkg.com/compare-versions/-/compare-versions-3.6.0.tgz#1a5689913685e5a87637b8d3ffca75514ec41d62" + integrity sha512-W6Af2Iw1z4CB7q4uU4hv646dW9GQuBM+YpC0UvUCWSD8w90SJjp+ujJuXaEMtAXBtSqGfMPuFOVn4/+FlaqfBA== + +concat-map@0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b" + integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s= + +cosmiconfig@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/cosmiconfig/-/cosmiconfig-6.0.0.tgz#da4fee853c52f6b1e6935f41c1a2fc50bd4a9982" + integrity sha512-xb3ZL6+L8b9JLLCx3ZdoZy4+2ECphCMo2PwqgP1tlfVq6M6YReyzBJtvWWtbDSpNr9hn96pkCiZqUcFEc+54Qg== + dependencies: + "@types/parse-json" "^4.0.0" + import-fresh "^3.1.0" + parse-json "^5.0.0" + path-type "^4.0.0" + yaml "^1.7.2" + +cross-spawn@^7.0.0: + version "7.0.3" + resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.3.tgz#f73a85b9d5d41d045551c177e2882d4ac85728a6" + integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w== + dependencies: + path-key "^3.1.0" + shebang-command "^2.0.0" + which "^2.0.1" + +debug@^4.1.1: + version "4.1.1" + resolved "https://registry.yarnpkg.com/debug/-/debug-4.1.1.tgz#3b72260255109c6b589cee050f1d516139664791" + integrity sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw== + dependencies: + ms "^2.1.1" + +dedent@^0.7.0: + version "0.7.0" + resolved "https://registry.yarnpkg.com/dedent/-/dedent-0.7.0.tgz#2495ddbaf6eb874abb0e1be9df22d2e5a544326c" + integrity sha1-JJXduvbrh0q7Dhvp3yLS5aVEMmw= + +emoji-regex@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" + integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== + +end-of-stream@^1.1.0: + version "1.4.4" + resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.4.4.tgz#5ae64a5f45057baf3626ec14da0ca5e4b2431eb0" + integrity sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q== + dependencies: + once "^1.4.0" + +enquirer@^2.3.5: + version "2.3.5" + resolved "https://registry.yarnpkg.com/enquirer/-/enquirer-2.3.5.tgz#3ab2b838df0a9d8ab9e7dff235b0e8712ef92381" + integrity sha512-BNT1C08P9XD0vNg3J475yIUG+mVdp9T6towYFHUv897X0KoHBjB1shyrNmhmtHWKP17iSWgo7Gqh7BBuzLZMSA== + dependencies: + ansi-colors "^3.2.1" + +error-ex@^1.3.1: + version "1.3.2" + resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.2.tgz#b4ac40648107fdcdcfae242f428bea8a14d4f1bf" + integrity sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g== + dependencies: + is-arrayish "^0.2.1" + +escape-string-regexp@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + integrity sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ= + +execa@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/execa/-/execa-2.1.0.tgz#e5d3ecd837d2a60ec50f3da78fd39767747bbe99" + integrity sha512-Y/URAVapfbYy2Xp/gb6A0E7iR8xeqOCXsuuaoMn7A5PzrXUK84E1gyiEfq0wQd/GHA6GsoHWwhNq8anb0mleIw== + dependencies: + cross-spawn "^7.0.0" + get-stream "^5.0.0" + is-stream "^2.0.0" + merge-stream "^2.0.0" + npm-run-path "^3.0.0" + onetime "^5.1.0" + p-finally "^2.0.0" + signal-exit "^3.0.2" + strip-final-newline "^2.0.0" + +execa@^4.0.1: + version "4.0.2" + resolved "https://registry.yarnpkg.com/execa/-/execa-4.0.2.tgz#ad87fb7b2d9d564f70d2b62d511bee41d5cbb240" + integrity sha512-QI2zLa6CjGWdiQsmSkZoGtDx2N+cQIGb3yNolGTdjSQzydzLgYYf8LRuagp7S7fPimjcrzUDSUFd/MgzELMi4Q== + dependencies: + cross-spawn "^7.0.0" + get-stream "^5.0.0" + human-signals "^1.1.1" + is-stream "^2.0.0" + merge-stream "^2.0.0" + npm-run-path "^4.0.0" + onetime "^5.1.0" + signal-exit "^3.0.2" + strip-final-newline "^2.0.0" + +figures@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/figures/-/figures-3.2.0.tgz#625c18bd293c604dc4a8ddb2febf0c88341746af" + integrity sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg== + dependencies: + escape-string-regexp "^1.0.5" + +fill-range@^7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/fill-range/-/fill-range-7.0.1.tgz#1919a6a7c75fe38b2c7c77e5198535da9acdda40" + integrity sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ== + dependencies: + to-regex-range "^5.0.1" + +find-up@^4.0.0, find-up@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-4.1.0.tgz#97afe7d6cdc0bc5928584b7c8d7b16e8a9aa5d19" + integrity sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw== + dependencies: + locate-path "^5.0.0" + path-exists "^4.0.0" + +find-versions@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/find-versions/-/find-versions-3.2.0.tgz#10297f98030a786829681690545ef659ed1d254e" + integrity sha512-P8WRou2S+oe222TOCHitLy8zj+SIsVJh52VP4lvXkaFVnOFFdoWv1H1Jjvel1aI6NCFOAaeAVm8qrI0odiLcww== + dependencies: + semver-regex "^2.0.0" + +get-own-enumerable-property-symbols@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz#b5fde77f22cbe35f390b4e089922c50bce6ef664" + integrity sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g== + +get-stream@^5.0.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-5.1.0.tgz#01203cdc92597f9b909067c3e656cc1f4d3c4dc9" + integrity sha512-EXr1FOzrzTfGeL0gQdeFEvOMm2mzMOglyiOXSTpPC+iAjAKftbr3jpCMWynogwYnM+eSj9sHGc6wjIcDvYiygw== + dependencies: + pump "^3.0.0" + +has-flag@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-3.0.0.tgz#b5d454dc2199ae225699f3467e5a07f3b955bafd" + integrity sha1-tdRU3CGZriJWmfNGfloH87lVuv0= + +has-flag@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" + integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== + +human-signals@^1.1.1: + version "1.1.1" + resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-1.1.1.tgz#c5b1cd14f50aeae09ab6c59fe63ba3395fe4dfa3" + integrity sha512-SEQu7vl8KjNL2eoGBLF3+wAjpsNfA9XMlXAYj/3EdaNfAlxKthD1xjEQfGOUhllCGGJVNY34bRr6lPINhNjyZw== + +husky@^4.2.5: + version "4.2.5" + resolved "https://registry.yarnpkg.com/husky/-/husky-4.2.5.tgz#2b4f7622673a71579f901d9885ed448394b5fa36" + integrity sha512-SYZ95AjKcX7goYVZtVZF2i6XiZcHknw50iXvY7b0MiGoj5RwdgRQNEHdb+gPDPCXKlzwrybjFjkL6FOj8uRhZQ== + dependencies: + chalk "^4.0.0" + ci-info "^2.0.0" + compare-versions "^3.6.0" + cosmiconfig "^6.0.0" + find-versions "^3.2.0" + opencollective-postinstall "^2.0.2" + pkg-dir "^4.2.0" + please-upgrade-node "^3.2.0" + slash "^3.0.0" + which-pm-runs "^1.0.0" + +ignore@^5.1.4: + version "5.1.8" + resolved "https://registry.yarnpkg.com/ignore/-/ignore-5.1.8.tgz#f150a8b50a34289b33e22f5889abd4d8016f0e57" + integrity sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw== + +import-fresh@^3.1.0: + version "3.2.1" + resolved "https://registry.yarnpkg.com/import-fresh/-/import-fresh-3.2.1.tgz#633ff618506e793af5ac91bf48b72677e15cbe66" + integrity sha512-6e1q1cnWP2RXD9/keSkxHScg508CdXqXWgWBaETNhyuBFz+kUZlKboh+ISK+bU++DmbHimVBrOz/zzPe0sZ3sQ== + dependencies: + parent-module "^1.0.0" + resolve-from "^4.0.0" + +indent-string@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/indent-string/-/indent-string-4.0.0.tgz#624f8f4497d619b2d9768531d58f4122854d7251" + integrity sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg== + +is-arrayish@^0.2.1: + version "0.2.1" + resolved "https://registry.yarnpkg.com/is-arrayish/-/is-arrayish-0.2.1.tgz#77c99840527aa8ecb1a8ba697b80645a7a926a9d" + integrity sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0= + +is-fullwidth-code-point@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" + integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== + +is-number@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/is-number/-/is-number-7.0.0.tgz#7535345b896734d5f80c4d06c50955527a14f12b" + integrity sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng== + +is-obj@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-1.0.1.tgz#3e4729ac1f5fde025cd7d83a896dab9f4f67db0f" + integrity sha1-PkcprB9f3gJc19g6iW2rn09n2w8= + +is-regexp@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-regexp/-/is-regexp-1.0.0.tgz#fd2d883545c46bac5a633e7b9a09e87fa2cb5069" + integrity sha1-/S2INUXEa6xaYz57mgnof6LLUGk= + +is-stream@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-2.0.0.tgz#bde9c32680d6fae04129d6ac9d921ce7815f78e3" + integrity sha512-XCoy+WlUr7d1+Z8GgSuXmpuUFC9fOhRXglJMx+dwLKTkL44Cjd4W1Z5P+BQZpr+cR93aGP4S/s7Ftw6Nd/kiEw== + +isexe@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" + integrity sha1-6PvzdNxVb/iUehDcsFctYz8s+hA= + +js-tokens@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" + integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== + +json-parse-better-errors@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz#bb867cfb3450e69107c131d1c514bab3dc8bcaa9" + integrity sha512-mrqyZKfX5EhL7hvqcV6WG1yYjnjeuYDzDhhcAAUrq8Po85NBQBJP+ZDUT75qZQ98IkUoBqdkExkukOU7Ts2wrw== + +lines-and-columns@^1.1.6: + version "1.1.6" + resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.1.6.tgz#1c00c743b433cd0a4e80758f7b64a57440d9ff00" + integrity sha1-HADHQ7QzzQpOgHWPe2SldEDZ/wA= + +lint-staged@>=10: + version "10.2.11" + resolved "https://registry.yarnpkg.com/lint-staged/-/lint-staged-10.2.11.tgz#713c80877f2dc8b609b05bc59020234e766c9720" + integrity sha512-LRRrSogzbixYaZItE2APaS4l2eJMjjf5MbclRZpLJtcQJShcvUzKXsNeZgsLIZ0H0+fg2tL4B59fU9wHIHtFIA== + dependencies: + chalk "^4.0.0" + cli-truncate "2.1.0" + commander "^5.1.0" + cosmiconfig "^6.0.0" + debug "^4.1.1" + dedent "^0.7.0" + enquirer "^2.3.5" + execa "^4.0.1" + listr2 "^2.1.0" + log-symbols "^4.0.0" + micromatch "^4.0.2" + normalize-path "^3.0.0" + please-upgrade-node "^3.2.0" + string-argv "0.3.1" + stringify-object "^3.3.0" + +listr2@^2.1.0: + version "2.1.8" + resolved "https://registry.yarnpkg.com/listr2/-/listr2-2.1.8.tgz#8af7ebc70cdbe866ddbb6c80909142bd45758f1f" + integrity sha512-Op+hheiChfAphkJ5qUxZtHgyjlX9iNnAeFS/S134xw7mVSg0YVrQo1IY4/K+ElY6XgOPg2Ij4z07urUXR+YEew== + dependencies: + chalk "^4.0.0" + cli-truncate "^2.1.0" + figures "^3.2.0" + indent-string "^4.0.0" + log-update "^4.0.0" + p-map "^4.0.0" + rxjs "^6.5.5" + through "^2.3.8" + +locate-path@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-5.0.0.tgz#1afba396afd676a6d42504d0a67a3a7eb9f62aa0" + integrity sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g== + dependencies: + p-locate "^4.1.0" + +log-symbols@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/log-symbols/-/log-symbols-4.0.0.tgz#69b3cc46d20f448eccdb75ea1fa733d9e821c920" + integrity sha512-FN8JBzLx6CzeMrB0tg6pqlGU1wCrXW+ZXGH481kfsBqer0hToTIiHdjH4Mq8xJUbvATujKCvaREGWpGUionraA== + dependencies: + chalk "^4.0.0" + +log-update@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/log-update/-/log-update-4.0.0.tgz#589ecd352471f2a1c0c570287543a64dfd20e0a1" + integrity sha512-9fkkDevMefjg0mmzWFBW8YkFP91OrizzkW3diF7CpG+S2EYdy4+TVfGwz1zeF8x7hCx1ovSPTOE9Ngib74qqUg== + dependencies: + ansi-escapes "^4.3.0" + cli-cursor "^3.1.0" + slice-ansi "^4.0.0" + wrap-ansi "^6.2.0" + +merge-stream@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/merge-stream/-/merge-stream-2.0.0.tgz#52823629a14dd00c9770fb6ad47dc6310f2c1f60" + integrity sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w== + +micromatch@^4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.2.tgz#4fcb0999bf9fbc2fcbdd212f6d629b9a56c39259" + integrity sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q== + dependencies: + braces "^3.0.1" + picomatch "^2.0.5" + +mimic-fn@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" + integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== + +minimatch@^3.0.4: + version "3.0.4" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083" + integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA== + dependencies: + brace-expansion "^1.1.7" + +mri@^1.1.4: + version "1.1.5" + resolved "https://registry.yarnpkg.com/mri/-/mri-1.1.5.tgz#ce21dba2c69f74a9b7cf8a1ec62307e089e223e0" + integrity sha512-d2RKzMD4JNyHMbnbWnznPaa8vbdlq/4pNZ3IgdaGrVbBhebBsGUUE/6qorTMYNS6TwuH3ilfOlD2bf4Igh8CKg== + +ms@^2.1.1: + version "2.1.2" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009" + integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w== + +multimatch@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/multimatch/-/multimatch-4.0.0.tgz#8c3c0f6e3e8449ada0af3dd29efb491a375191b3" + integrity sha512-lDmx79y1z6i7RNx0ZGCPq1bzJ6ZoDDKbvh7jxr9SJcWLkShMzXrHbYVpTdnhNM5MXpDUxCQ4DgqVttVXlBgiBQ== + dependencies: + "@types/minimatch" "^3.0.3" + array-differ "^3.0.0" + array-union "^2.1.0" + arrify "^2.0.1" + minimatch "^3.0.4" + +normalize-path@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/normalize-path/-/normalize-path-3.0.0.tgz#0dcd69ff23a1c9b11fd0978316644a0388216a65" + integrity sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA== + +npm-run-path@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-3.1.0.tgz#7f91be317f6a466efed3c9f2980ad8a4ee8b0fa5" + integrity sha512-Dbl4A/VfiVGLgQv29URL9xshU8XDY1GeLy+fsaZ1AA8JDSfjvr5P5+pzRbWqRSBxk6/DW7MIh8lTM/PaGnP2kg== + dependencies: + path-key "^3.0.0" + +npm-run-path@^4.0.0: + version "4.0.1" + resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-4.0.1.tgz#b7ecd1e5ed53da8e37a55e1c2269e0b97ed748ea" + integrity sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw== + dependencies: + path-key "^3.0.0" + +once@^1.3.1, once@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha1-WDsap3WWHUsROsF9nFC6753Xa9E= + dependencies: + wrappy "1" + +onetime@^5.1.0: + version "5.1.0" + resolved "https://registry.yarnpkg.com/onetime/-/onetime-5.1.0.tgz#fff0f3c91617fe62bb50189636e99ac8a6df7be5" + integrity sha512-5NcSkPHhwTVFIQN+TUqXoS5+dlElHXdpAWu9I0HP20YOtIi+aZ0Ct82jdlILDxjLEAWwvm+qj1m6aEtsDVmm6Q== + dependencies: + mimic-fn "^2.1.0" + +opencollective-postinstall@^2.0.2: + version "2.0.3" + resolved "https://registry.yarnpkg.com/opencollective-postinstall/-/opencollective-postinstall-2.0.3.tgz#7a0fff978f6dbfa4d006238fbac98ed4198c3259" + integrity sha512-8AV/sCtuzUeTo8gQK5qDZzARrulB3egtLzFgteqB2tcT4Mw7B8Kt7JcDHmltjz6FOAHsvTevk70gZEbhM4ZS9Q== + +p-finally@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/p-finally/-/p-finally-2.0.1.tgz#bd6fcaa9c559a096b680806f4d657b3f0f240561" + integrity sha512-vpm09aKwq6H9phqRQzecoDpD8TmVyGw70qmWlyq5onxY7tqyTTFVvxMykxQSQKILBSFlbXpypIw2T1Ml7+DDtw== + +p-limit@^2.2.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1" + integrity sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w== + dependencies: + p-try "^2.0.0" + +p-locate@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-4.1.0.tgz#a3428bb7088b3a60292f66919278b7c297ad4f07" + integrity sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A== + dependencies: + p-limit "^2.2.0" + +p-map@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/p-map/-/p-map-4.0.0.tgz#bb2f95a5eda2ec168ec9274e06a747c3e2904d2b" + integrity sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ== + dependencies: + aggregate-error "^3.0.0" + +p-try@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/p-try/-/p-try-2.2.0.tgz#cb2868540e313d61de58fafbe35ce9004d5540e6" + integrity sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== + +parent-module@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/parent-module/-/parent-module-1.0.1.tgz#691d2709e78c79fae3a156622452d00762caaaa2" + integrity sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g== + dependencies: + callsites "^3.0.0" + +parse-json@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/parse-json/-/parse-json-5.0.0.tgz#73e5114c986d143efa3712d4ea24db9a4266f60f" + integrity sha512-OOY5b7PAEFV0E2Fir1KOkxchnZNCdowAJgQ5NuxjpBKTRP3pQhwkrkxqQjeoKJ+fO7bCpmIZaogI4eZGDMEGOw== + dependencies: + "@babel/code-frame" "^7.0.0" + error-ex "^1.3.1" + json-parse-better-errors "^1.0.1" + lines-and-columns "^1.1.6" + +path-exists@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3" + integrity sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w== + +path-key@^3.0.0, path-key@^3.1.0: + version "3.1.1" + resolved "https://registry.yarnpkg.com/path-key/-/path-key-3.1.1.tgz#581f6ade658cbba65a0d3380de7753295054f375" + integrity sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q== + +path-type@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-type/-/path-type-4.0.0.tgz#84ed01c0a7ba380afe09d90a8c180dcd9d03043b" + integrity sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw== + +picomatch@^2.0.5: + version "2.2.2" + resolved "https://registry.yarnpkg.com/picomatch/-/picomatch-2.2.2.tgz#21f333e9b6b8eaff02468f5146ea406d345f4dad" + integrity sha512-q0M/9eZHzmr0AulXyPwNfZjtwZ/RBZlbN3K3CErVrk50T2ASYI7Bye0EvekFY3IP1Nt2DHu0re+V2ZHIpMkuWg== + +pkg-dir@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/pkg-dir/-/pkg-dir-4.2.0.tgz#f099133df7ede422e81d1d8448270eeb3e4261f3" + integrity sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ== + dependencies: + find-up "^4.0.0" + +please-upgrade-node@^3.2.0: + version "3.2.0" + resolved "https://registry.yarnpkg.com/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz#aeddd3f994c933e4ad98b99d9a556efa0e2fe942" + integrity sha512-gQR3WpIgNIKwBMVLkpMUeR3e1/E1y42bqDQZfql+kDeXd8COYfM8PQA4X6y7a8u9Ua9FHmsrrmirW2vHs45hWg== + dependencies: + semver-compare "^1.0.0" + +prettier@^2.0.5: + version "2.0.5" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.0.5.tgz#d6d56282455243f2f92cc1716692c08aa31522d4" + integrity sha512-7PtVymN48hGcO4fGjybyBSIWDsLU4H4XlvOHfq91pz9kkGlonzwTfYkaIEwiRg/dAJF9YlbsduBAgtYLi+8cFg== + +pretty-quick@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/pretty-quick/-/pretty-quick-2.0.1.tgz#417ee605ade98ecc686e72f63b5d28a2c35b43e9" + integrity sha512-y7bJt77XadjUr+P1uKqZxFWLddvj3SKY6EU4BuQtMxmmEFSMpbN132pUWdSG1g1mtUfO0noBvn7wBf0BVeomHg== + dependencies: + chalk "^2.4.2" + execa "^2.1.0" + find-up "^4.1.0" + ignore "^5.1.4" + mri "^1.1.4" + multimatch "^4.0.0" + +pump@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.0.tgz#b4a2116815bde2f4e1ea602354e8c75565107a64" + integrity sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww== + dependencies: + end-of-stream "^1.1.0" + once "^1.3.1" + +resolve-from@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/resolve-from/-/resolve-from-4.0.0.tgz#4abcd852ad32dd7baabfe9b40e00a36db5f392e6" + integrity sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g== + +restore-cursor@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/restore-cursor/-/restore-cursor-3.1.0.tgz#39f67c54b3a7a58cea5236d95cf0034239631f7e" + integrity sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA== + dependencies: + onetime "^5.1.0" + signal-exit "^3.0.2" + +rxjs@^6.5.5: + version "6.5.5" + resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-6.5.5.tgz#c5c884e3094c8cfee31bf27eb87e54ccfc87f9ec" + integrity sha512-WfQI+1gohdf0Dai/Bbmk5L5ItH5tYqm3ki2c5GdWhKjalzjg93N3avFjVStyZZz+A2Em+ZxKH5bNghw9UeylGQ== + dependencies: + tslib "^1.9.0" + +semver-compare@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/semver-compare/-/semver-compare-1.0.0.tgz#0dee216a1c941ab37e9efb1788f6afc5ff5537fc" + integrity sha1-De4hahyUGrN+nvsXiPavxf9VN/w= + +semver-regex@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/semver-regex/-/semver-regex-2.0.0.tgz#a93c2c5844539a770233379107b38c7b4ac9d338" + integrity sha512-mUdIBBvdn0PLOeP3TEkMH7HHeUP3GjsXCwKarjv/kGmUFOYg1VqEemKhoQpWMu6X2I8kHeuVdGibLGkVK+/5Qw== + +shebang-command@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-2.0.0.tgz#ccd0af4f8835fbdc265b82461aaf0c36663f34ea" + integrity sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA== + dependencies: + shebang-regex "^3.0.0" + +shebang-regex@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" + integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== + +signal-exit@^3.0.2: + version "3.0.3" + resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.3.tgz#a1410c2edd8f077b08b4e253c8eacfcaf057461c" + integrity sha512-VUJ49FC8U1OxwZLxIbTTrDvLnf/6TDgxZcK8wxR8zs13xpx7xbG60ndBlhNrFi2EMuFRoeDoJO7wthSLq42EjA== + +slash@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634" + integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q== + +slice-ansi@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/slice-ansi/-/slice-ansi-3.0.0.tgz#31ddc10930a1b7e0b67b08c96c2f49b77a789787" + integrity sha512-pSyv7bSTC7ig9Dcgbw9AuRNUb5k5V6oDudjZoMBSr13qpLBG7tB+zgCkARjq7xIUgdz5P1Qe8u+rSGdouOOIyQ== + dependencies: + ansi-styles "^4.0.0" + astral-regex "^2.0.0" + is-fullwidth-code-point "^3.0.0" + +slice-ansi@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/slice-ansi/-/slice-ansi-4.0.0.tgz#500e8dd0fd55b05815086255b3195adf2a45fe6b" + integrity sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ== + dependencies: + ansi-styles "^4.0.0" + astral-regex "^2.0.0" + is-fullwidth-code-point "^3.0.0" + +string-argv@0.3.1: + version "0.3.1" + resolved "https://registry.yarnpkg.com/string-argv/-/string-argv-0.3.1.tgz#95e2fbec0427ae19184935f816d74aaa4c5c19da" + integrity sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg== + +string-width@^4.1.0, string-width@^4.2.0: + version "4.2.0" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.0.tgz#952182c46cc7b2c313d1596e623992bd163b72b5" + integrity sha512-zUz5JD+tgqtuDjMhwIg5uFVV3dtqZ9yQJlZVfq4I01/K5Paj5UHj7VyrQOJvzawSVlKpObApbfD0Ed6yJc+1eg== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.0" + +stringify-object@^3.3.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/stringify-object/-/stringify-object-3.3.0.tgz#703065aefca19300d3ce88af4f5b3956d7556629" + integrity sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw== + dependencies: + get-own-enumerable-property-symbols "^3.0.0" + is-obj "^1.0.1" + is-regexp "^1.0.0" + +strip-ansi@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.0.tgz#0b1571dd7669ccd4f3e06e14ef1eed26225ae532" + integrity sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w== + dependencies: + ansi-regex "^5.0.0" + +strip-final-newline@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/strip-final-newline/-/strip-final-newline-2.0.0.tgz#89b852fb2fcbe936f6f4b3187afb0a12c1ab58ad" + integrity sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA== + +supports-color@^5.3.0: + version "5.5.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" + integrity sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow== + dependencies: + has-flag "^3.0.0" + +supports-color@^7.1.0: + version "7.1.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-7.1.0.tgz#68e32591df73e25ad1c4b49108a2ec507962bfd1" + integrity sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g== + dependencies: + has-flag "^4.0.0" + +through@^2.3.8: + version "2.3.8" + resolved "https://registry.yarnpkg.com/through/-/through-2.3.8.tgz#0dd4c9ffaabc357960b1b724115d7e0e86a2e1f5" + integrity sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU= + +to-regex-range@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/to-regex-range/-/to-regex-range-5.0.1.tgz#1648c44aae7c8d988a326018ed72f5b4dd0392e4" + integrity sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ== + dependencies: + is-number "^7.0.0" + +tslib@^1.9.0: + version "1.13.0" + resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.13.0.tgz#c881e13cc7015894ed914862d276436fa9a47043" + integrity sha512-i/6DQjL8Xf3be4K/E6Wgpekn5Qasl1usyw++dAA35Ue5orEn65VIxOA+YvNNl9HV3qv70T7CNwjODHZrLwvd1Q== + +type-fest@^0.11.0: + version "0.11.0" + resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.11.0.tgz#97abf0872310fed88a5c466b25681576145e33f1" + integrity sha512-OdjXJxnCN1AvyLSzeKIgXTXxV+99ZuXl3Hpo9XpJAv9MBcHrrJOQ5kV7ypXOuQie+AmWG25hLbiKdwYTifzcfQ== + +which-pm-runs@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/which-pm-runs/-/which-pm-runs-1.0.0.tgz#670b3afbc552e0b55df6b7780ca74615f23ad1cb" + integrity sha1-Zws6+8VS4LVd9rd4DKdGFfI60cs= + +which@^2.0.1: + version "2.0.2" + resolved "https://registry.yarnpkg.com/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1" + integrity sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA== + dependencies: + isexe "^2.0.0" + +wrap-ansi@^6.2.0: + version "6.2.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53" + integrity sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8= + +yaml@^1.7.2: + version "1.10.0" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.0.tgz#3b593add944876077d4d683fee01081bd9fff31e" + integrity sha512-yr2icI4glYaNG+KWONODapy2/jDdMSDnrONSjblABjD9B4Z5LgiircSt8m8sRZFNi08kG9Sm0uSHtEmP3zaEGg== From 340f648353bc2efab198327ce87e6f940a90355a Mon Sep 17 00:00:00 2001 From: Jake Wiesler Date: Sat, 27 Jun 2020 10:56:37 -0400 Subject: [PATCH 2/5] update CONTRIBUTING.md --- CONTRIBUTING.md | 26 ++++++-------------------- 1 file changed, 6 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ab1137d..e03a7d94 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,13 +3,6 @@ First off, thank you for your time and effort! This project is not very large and easy to jump into. -## Development stack - -- Built with [Hugo](https://gohugo.io/) 🔥 -- [Gulp](https://gulpjs.com/) as a build tool 🍹 -- Styles in [Stylus](http://stylus-lang.com/) 💅🏻 -- [Yarn](https://yarnpkg.com/) as a package manager 📦 - ## Getting started 1. Fork and clone the repository @@ -23,29 +16,22 @@ yarn install ## Scripts -There are 3 npm scripts that can be used for development purposes: - ```bash yarn develop ``` -This command will start a hugo webserver and serve the `exampleSite`. This works -well because the example site uses `hugo-theme-codex`, so any changes we make to -the codebase can be viewed in real time. +Triggers a one-time build of the static directory. ```bash -yarn watch:assets +yarn format ``` -If you are working with `js` or `css` you will probably want to run this command -in a separate tab from `yarn develop` so that any changes to assets like -javascript and css will trigger a re-build by `gulp``. +Runs prettier on the entire project directory. -```bash -yarn build:assets -``` +## Assets -Triggers a one-time build of the static directory. +The `assets/` directory is where you can write JS and SCSS, which get processed +into CSS files before being placed in the `static/` directory. ## Questions From 4588bdd81b850af05bfb039cecdab1e9c1098c1f Mon Sep 17 00:00:00 2001 From: Jake Wiesler Date: Sat, 27 Jun 2020 18:38:49 -0400 Subject: [PATCH 3/5] refactor: ignore exampleSite/content dir --- .prettierignore | 1 + exampleSite/content/blog/example-post.md | 34 +------ exampleSite/content/blog/markdown-syntax.md | 95 +++++++------------- exampleSite/content/blog/math-typesetting.md | 26 ++---- exampleSite/content/blog/rich-content.md | 9 +- package.json | 2 +- 6 files changed, 51 insertions(+), 116 deletions(-) diff --git a/.prettierignore b/.prettierignore index 9f411305..2cff650c 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,3 +1,4 @@ +exampleSite/content layouts static diff --git a/exampleSite/content/blog/example-post.md b/exampleSite/content/blog/example-post.md index 7cde4b7c..5f8b62b3 100644 --- a/exampleSite/content/blog/example-post.md +++ b/exampleSite/content/blog/example-post.md @@ -12,40 +12,12 @@ toc: true ## The standard Lorem Ipsum passage -"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor -incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis -nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. -Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu -fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in -culpa qui officia deserunt mollit anim id est laborum." +"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum." ## written by Cicero in 45 BC -"Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium -doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore -veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam -voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia -consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque -porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci -velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore -magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum -exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi -consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit -esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo -voluptas nulla pariatur?" +"Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?" ## 1914 translation by H. Rackham -"But I must explain to you how all this mistaken idea of denouncing pleasure and -praising pain was born and I will give you a complete account of the system, and -expound the actual teachings of the great explorer of the truth, the -master-builder of human happiness. No one rejects, dislikes, or avoids pleasure -itself, because it is pleasure, but because those who do not know how to pursue -pleasure rationally encounter consequences that are extremely painful. Nor again -is there anyone who loves or pursues or desires to obtain pain of itself, -because it is pain, but because occasionally circumstances occur in which toil -and pain can procure him some great pleasure. To take a trivial example, which -of us ever undertakes laborious physical exercise, except to obtain some -advantage from it? But who has any right to find fault with a man who chooses to -enjoy a pleasure that has no annoying consequences, or one who avoids a pain -that produces no resultant pleasure?" +"But I must explain to you how all this mistaken idea of denouncing pleasure and praising pain was born and I will give you a complete account of the system, and expound the actual teachings of the great explorer of the truth, the master-builder of human happiness. No one rejects, dislikes, or avoids pleasure itself, because it is pleasure, but because those who do not know how to pursue pleasure rationally encounter consequences that are extremely painful. Nor again is there anyone who loves or pursues or desires to obtain pain of itself, because it is pain, but because occasionally circumstances occur in which toil and pain can procure him some great pleasure. To take a trivial example, which of us ever undertakes laborious physical exercise, except to obtain some advantage from it? But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?" diff --git a/exampleSite/content/blog/markdown-syntax.md b/exampleSite/content/blog/markdown-syntax.md index d1523082..39b0b6d9 100644 --- a/exampleSite/content/blog/markdown-syntax.md +++ b/exampleSite/content/blog/markdown-syntax.md @@ -2,9 +2,7 @@ title: "Markdown Syntax Guide" date: 2020-06-05 slug: "markdown-syntax-guide" -description: - "Sample article showcasing basic Markdown syntax and formatting for HTML - elements" +description: "Sample article showcasing basic Markdown syntax and formatting for HTML elements" keywords: ["gohugo", "hugo", "go", "blog"] draft: false tags: ["markdown", "css", "html", "themes"] @@ -12,79 +10,57 @@ math: false toc: false --- -This article offers a sample of basic Markdown syntax that can be used in Hugo -content files, also it shows whether basic HTML elements are decorated with CSS -in a Hugo theme. - +This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme. ## Headings -The following HTML `

`—`

` elements represent six levels of section -headings. `

` is the highest section level while `

` is the lowest. +The following HTML `

`—`

` elements represent six levels of section headings. `

` is the highest section level while `

` is the lowest. # H1 - ## H2 - ### H3 - #### H4 - ##### H5 - ###### H6 ## Paragraph -Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, -voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma -dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as -cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin -porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? -Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit -ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda -veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore -eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata -tiustia prat. +Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat. -Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne -sapicia is sinveli squiatum, core et que aut hariosam ex eat. +Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat. ## Blockquotes -The blockquote element represents content that is quoted from another source, -optionally with a citation which must be within a `footer` or `cite` element, -and optionally with in-line changes such as annotations and abbreviations. +The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a `footer` or `cite` element, and optionally with in-line changes such as annotations and abbreviations. #### Blockquote without attribution -> Tiam, ad mint andaepu dandae nostion secatur sequo quae. **Note** that you can -> use _Markdown syntax_ within a blockquote. +> Tiam, ad mint andaepu dandae nostion secatur sequo quae. +> **Note** that you can use *Markdown syntax* within a blockquote. #### Blockquote with attribution -> Simplicity is the ultimate sophistication. Leonardo da Vinci[^1] +> Simplicity is the ultimate sophistication. +> Leonardo da Vinci[^1] + +[^1]: The above quote is often attributed to Leonardo da Vinci but there is no concrete evidence to support this. -[^1]: - The above quote is often attributed to Leonardo da Vinci but there is no - concrete evidence to support this. ## Tables -Tables aren't part of the core Markdown spec, but Hugo supports supports them -out-of-the-box. +Tables aren't part of the core Markdown spec, but Hugo supports supports them out-of-the-box. -| Name | Age | -| ----- | --- | -| Bob | 27 | -| Alice | 23 | + Name | Age +--------|------ + Bob | 27 + Alice | 23 #### Inline Markdown within tables -| Inline    | Markdown    | In    | Table | -| ------------------------ | -------------------------- | ----------------------------------- | ------ | -| _italics_ | **bold** | ~~strikethrough~~    | `code` | +| Inline    | Markdown    | In    | Table | +| ---------- | --------- | ----------------- | ---------- | +| *italics* | **bold** | ~~strikethrough~~    | `code` | ## Code Blocks @@ -103,7 +79,6 @@ html ``` - #### Code block indented with four spaces @@ -118,17 +93,16 @@ html #### Code block with Hugo's internal highlight shortcode - ```html - - - Example HTML5 Document - - -

Test

- + + + Example HTML5 Document + + +

Test

+ ``` @@ -142,14 +116,13 @@ html #### Unordered List -- List item -- Another item -- And another item +* List item +* Another item +* And another item #### Nested list -- Item - +* Item 1. First Sub-item 2. Second Sub-item @@ -161,8 +134,6 @@ H2O Xn + Yn = Zn -Press CTRL+ALT+Delete to end the -session. +Press CTRL+ALT+Delete to end the session. -Most salamanders are nocturnal, and hunt for insects, worms, and -other small creatures. +Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures. diff --git a/exampleSite/content/blog/math-typesetting.md b/exampleSite/content/blog/math-typesetting.md index aec48211..d7ce7711 100644 --- a/exampleSite/content/blog/math-typesetting.md +++ b/exampleSite/content/blog/math-typesetting.md @@ -10,34 +10,26 @@ math: true toc: false --- -Mathematical notation in a Hugo project can be enabled by using third party -JavaScript libraries. - +Mathematical notation in a Hugo project can be enabled by using third party JavaScript libraries. In this example we will be using [KaTeX](https://katex.org/) - Create a partial under `/layouts/partials/math.html` -- Within this partial reference the - [Auto-render Extension](https://katex.org/docs/autorender.html) or host these - scripts locally. -- Include the partial in your templates like so: +- Within this partial reference the [Auto-render Extension](https://katex.org/docs/autorender.html) or host these scripts locally. +- Include the partial in your templates like so: ``` {{ if or .Params.math .Site.Params.math }} {{ partial "math.html" . }} {{ end }} -``` - -- To enable KaTex globally set the parameter `math` to `true` in a project's - configuration -- To enable KaTex on a per page basis include the parameter `math: true` in - content files. - -**Note:** Use the online reference of -[Supported TeX Functions](https://katex.org/docs/supported.html) -{{< math.inline >}} {{ if or .Page.Params.math .Site.Params.math }} +``` +- To enable KaTex globally set the parameter `math` to `true` in a project's configuration +- To enable KaTex on a per page basis include the parameter `math: true` in content files. +**Note:** Use the online reference of [Supported TeX Functions](https://katex.org/docs/supported.html) +{{< math.inline >}} +{{ if or .Page.Params.math .Site.Params.math }} diff --git a/exampleSite/content/blog/rich-content.md b/exampleSite/content/blog/rich-content.md index 741d3832..c69a34bd 100644 --- a/exampleSite/content/blog/rich-content.md +++ b/exampleSite/content/blog/rich-content.md @@ -10,24 +10,23 @@ math: false toc: false --- -Hugo ships with several -[Built-in Shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugo-s-built-in-shortcodes) -for rich content, along with a -[Privacy Config](https://gohugo.io/about/hugo-and-gdpr/) and a set of Simple -Shortcodes that enable static and no-JS versions of various social media embeds. +Hugo ships with several [Built-in Shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugo-s-built-in-shortcodes) for rich content, along with a [Privacy Config](https://gohugo.io/about/hugo-and-gdpr/) and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds. ## Instagram Simple Shortcode {{< instagram_simple BGvuInzyFAe hidecaption >}} + ## YouTube Privacy Enhanced Shortcode {{< youtube ZJthWmvUzzc >}} + ## Twitter Simple Shortcode {{< tweet 1085870671291310081 >}} + ## Vimeo Simple Shortcode {{< vimeo_simple 48912912 >}} diff --git a/package.json b/package.json index 24d8933e..8ffaece7 100644 --- a/package.json +++ b/package.json @@ -30,6 +30,6 @@ "go" ], "lint-staged": { - "*.{js,css,scss,md}": "prettier --write" + "*.{js,css,scss}": "prettier --write" } } From 1231d79de15fc1df8ea226db91e1016970bc1194 Mon Sep 17 00:00:00 2001 From: Jake Wiesler Date: Sat, 27 Jun 2020 18:39:04 -0400 Subject: [PATCH 4/5] refactor: use semicolon in js --- prettier.config.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/prettier.config.js b/prettier.config.js index 7a9bf1c2..d174dc08 100644 --- a/prettier.config.js +++ b/prettier.config.js @@ -5,9 +5,9 @@ module.exports = { htmlWhitespaceSensitivity: "css", printWidth: 80, proseWrap: "always", - semi: false, + semi: true, singleQuote: false, tabWidth: 2, trailingComma: "all", useTabs: false, -} +}; From 1356d79861e9e07f9fd5c9c9375e7c7357ac06e1 Mon Sep 17 00:00:00 2001 From: Jake Wiesler Date: Sun, 28 Jun 2020 21:59:54 -0400 Subject: [PATCH 5/5] refactor: revert md/js files --- README.md | 102 ++++++++------------------------- assets/js/index.js | 10 ++-- static/js/table-of-contents.js | 26 ++++----- 3 files changed, 40 insertions(+), 98 deletions(-) diff --git a/README.md b/README.md index bd95507c..b2d7072d 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,9 @@ A minimal blog theme built for [Hugo](https://gohugo.io/) 🍜 Hugo **extended version** (for Sass/SCSS support). -For macOS users, the extended version is installed by default if you use -`homebrew`. +For macOS users, the extended version is installed by default if you use `homebrew`. For Windows users, you can install with `choco`: - ``` choco install hugo-extended -confirm ``` @@ -29,24 +27,19 @@ At the root of your Hugo project, run: git submodule add https://github.com/jakewies/hugo-theme-codex.git themes/codex ``` -Next, copy the contents of the -[default `config.toml`](https://github.com/jakewies/hugo-theme-codex/blob/master/exampleSite/config.toml) -to your site's `config.toml`. Make sure to read all the comments, as there a few -nuances with Hugo themes that require some changes to that file. +Next, copy the contents of the [default `config.toml`](https://github.com/jakewies/hugo-theme-codex/blob/master/exampleSite/config.toml) to your site's `config.toml`. Make sure to read all the comments, as there a few nuances with Hugo themes that require some changes to that file. Finally, run: ``` -hugo server -D +hugo server -D ``` -**Note: If you are seeing a blank page it is probably because you have nothing -in your `content/` directory. Read on to fix that.** +**Note: If you are seeing a blank page it is probably because you have nothing in your `content/` directory. Read on to fix that.** ### Configuring the Home Page -The site's home page can be configured by creating a `content/_index.md` file. -This file can use the following frontmatter: +The site's home page can be configured by creating a `content/_index.md` file. This file can use the following frontmatter: ```md --- @@ -56,15 +49,11 @@ handle: "hugo-theme-codex" --- ``` -If you would rather override the about page's layout with your own, you can do -so by creating a `layouts/index.html`. You can find the `index.html` file that -`hugo-theme-codex` uses -[here](https://github.com/jakewies/hugo-theme-codex/blob/master/layouts/index.html). +If you would rather override the about page's layout with your own, you can do so by creating a `layouts/index.html`. You can find the `index.html` file that `hugo-theme-codex` uses [here](https://github.com/jakewies/hugo-theme-codex/blob/master/layouts/index.html). ### Configuring Social Icons -Social Icons are optional. To show any of these icons, just provide the value in -the `[params]` section of `config.toml`. +Social Icons are optional. To show any of these icons, just provide the value in the `[params]` section of `config.toml`. ```toml # config.toml @@ -77,94 +66,65 @@ the `[params]` section of `config.toml`. iconTitles = ["Twitter", "GitHub"] ``` -If any of these options are given, `hugo-theme-codex` will render the social -icon in the footer, using the order specified in `iconTitles`. +If any of these options are given, `hugo-theme-codex` will render the social icon in the footer, using the order specified in `iconTitles`. -See the contents of the -[example site](https://github.com/jakewies/hugo-theme-codex/tree/master/exampleSite) -for more details. +See the contents of the [example site](https://github.com/jakewies/hugo-theme-codex/tree/master/exampleSite) for more details. You can also create additional social icons by: - -1. Adding your own SVGs in `static/images/social/`, for example - `static/images/social/reddit.svg`. +1. Adding your own SVGs in `static/images/social/`, for example `static/images/social/reddit.svg`. 2. Modifying your site's config as follows: - ```toml [params] # ... reddit = "" - + iconTitles = [ "...", "Reddit"] ``` -Make sure that the icon title must match the icon's file name. If the title -contains more than one word, say "My Awesome Site", you can use dash "-" for the -icon name: `my-awesome-site.svg`. +Make sure that the icon title must match the icon's file name. If the title contains more than one word, say "My Awesome Site", +you can use dash "-" for the icon name: `my-awesome-site.svg`. ### Creating a blog post -You can create a new blog post page by going to the root of your project and -typing: +You can create a new blog post page by going to the root of your project and typing: ``` hugo new blog/:blog-post.md ``` -Where `:blog-post.md` is the name of the file of your new post. +Where `:blog-post.md` is the name of the file of your new post. -This will execute the theme's `blog` archetype to create a new markdown file in -`contents/blog/:blog-post.md` with the following frontmatter: +This will execute the theme's `blog` archetype to create a new markdown file in `contents/blog/:blog-post.md` with the following frontmatter: ```md # Default post frontmatter: # The title of your post. Default value is generated - # From the markdown filename - title: "{{ replace .TranslationBaseName "-" " " | title }}" - # The date the post was created - date: {{ .Date }} - # The post filename - slug: "" - # Post description used for seo - description: "" - # Post keywords used for seo - keywords: [] - # If true, the blog post will not be included in static build - draft: true - # Categorize your post with tags - tags: [] - # Uses math typesetting - math: false - # Includes a table of contents on screens >1024px - toc: false ``` -The frontmatter above is the default for a new post, but all values can be -changed. +The frontmatter above is the default for a new post, but all values can be changed. ### Adding a new section menu In your site's `config.toml`, add a new menu definition for say, "photos": - ```toml # config.toml @@ -175,13 +135,12 @@ In your site's `config.toml`, add a new menu definition for say, "photos": url = "/photos" ``` -Then, put your posts under "content/photos". +Then, put your posts under "content/photos". ### Custom styling -In your site's folder, create `assets/scss/custom.scss` and put your custom -styling there. For example, the snippet below changes the dot's color on your -About page to blue: +In your site's folder, create `assets/scss/custom.scss` and put your custom styling there. For example, the snippet below +changes the dot's color on your About page to blue: ```scss // custom.scss @@ -207,31 +166,23 @@ You can even use Hugo variables/params in your custom styles too! ### Tags -Right now `hugo-theme-codex` uses the `tags` taxonomy for blog posts. You can -view all the blog posts of a given tag by going to `/tags/:tag-name`, where -`:tag-name` is the name of your tag. +Right now `hugo-theme-codex` uses the `tags` taxonomy for blog posts. You can view all the blog posts of a given tag by going to `/tags/:tag-name`, where `:tag-name` is the name of your tag. ### Favicon -To update favicon of the site, replace the one in `static/favicon.ico` with your -own. +To update favicon of the site, replace the one in `static/favicon.ico` with your own. ## Contributing -Check out the -[CONTRIBUTORS.md file](https://github.com/jakewies/hugo-theme-codex/blob/master/CONTRIBUTING.md) -for more info on how you can contribute! +Check out the [CONTRIBUTORS.md file](https://github.com/jakewies/hugo-theme-codex/blob/master/CONTRIBUTING.md) for more info on how you can contribute! ## Contributors ✨ - [![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-) - -Thanks goes to these wonderful people -([emoji key](https://allcontributors.org/docs/en/emoji-key)): +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): @@ -250,9 +201,6 @@ Thanks goes to these wonderful people - -This project follows the -[all-contributors](https://github.com/all-contributors/all-contributors) -specification. Contributions of any kind welcome! +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/assets/js/index.js b/assets/js/index.js index 3c46c674..66edd2e7 100644 --- a/assets/js/index.js +++ b/assets/js/index.js @@ -3,8 +3,8 @@ */ function toggleMobileNavState() { - const body = document.querySelector("body") - body.classList.toggle("nav--active") + const body = document.querySelector("body"); + body.classList.toggle("nav--active"); } /* @@ -12,8 +12,8 @@ function toggleMobileNavState() { */ function initBurger() { - const burger = document.querySelector(".burger") - burger.addEventListener("click", toggleMobileNavState) + const burger = document.querySelector(".burger"); + burger.addEventListener("click", toggleMobileNavState); } -initBurger() +initBurger(); diff --git a/static/js/table-of-contents.js b/static/js/table-of-contents.js index aaf0ca62..911adbf6 100644 --- a/static/js/table-of-contents.js +++ b/static/js/table-of-contents.js @@ -1,23 +1,17 @@ -window.addEventListener("DOMContentLoaded", () => { +window.addEventListener('DOMContentLoaded', () => { const observer = new IntersectionObserver(entries => { entries.forEach(entry => { - const id = entry.target.getAttribute("id") + const id = entry.target.getAttribute('id'); if (entry.intersectionRatio > 0) { - document - .querySelector(`#TableOfContents ul li a[href="#${id}"]`) - .classList.add("active") + document.querySelector(`#TableOfContents ul li a[href="#${id}"]`).classList.add('active'); } else { - document - .querySelector(`#TableOfContents ul li a[href="#${id}"]`) - .classList.remove("active") + document.querySelector(`#TableOfContents ul li a[href="#${id}"]`).classList.remove('active'); } - }) - }) + }); + }); // Track all headers that have an `id` applied - document - .querySelectorAll("article h3[id], article h2[id]") - .forEach(section => { - observer.observe(section) - }) -}) + document.querySelectorAll('article h3[id], article h2[id]').forEach((section) => { + observer.observe(section); + }); +});