diff --git a/package.json b/package.json index 6507bdc8..23124772 100644 --- a/package.json +++ b/package.json @@ -44,6 +44,7 @@ "lint:style:fix": "stylelint '*/**/*.{css,scss}' --fix", "format": "prettier --write \"*.{css,js,json,md,scss}\" \"./**/*.{css,js,json,md,scss}\"", "stylelint-conflict-check": "stylelint-config-prettier-check", + "update:starter": "scripts/update-starter.sh", "update:starters": "hugo mod get -u ./..." } } diff --git a/scripts/update-starter.sh b/scripts/update-starter.sh new file mode 100755 index 00000000..a3c8eea5 --- /dev/null +++ b/scripts/update-starter.sh @@ -0,0 +1,5 @@ +#!/usr/bin/env zsh + +cd "starters/$1" +hugo mod get -u ./... +cd ../.. diff --git a/starters/notes/README.md b/starters/notes/README.md index fa647de0..8e5051f4 100644 --- a/starters/notes/README.md +++ b/starters/notes/README.md @@ -4,7 +4,7 @@ The **Notes** starter template empowers you to easily create **personal notes** and **knowledge bases** in a future-proof way. -- It is your second brain 🧠, stored in future-proof Markdown files +- It is your **second brain** 🧠, stored in **future-proof** Markdown files - Supports audio, video, images, math, code, [Mermaid](https://mermaid.live/) diagrams, and [much more](https://wowchemy.com/docs/content/writing-markdown-latex/) - Edit your notes online in GitHub, or any Git-connected Markdown app such as [Obsidian](https://obsidian.md/) or [Visual Studio Code](https://vscode.dev/) diff --git a/starters/notes/assets/media/book.svg b/starters/notes/assets/media/book.svg deleted file mode 100644 index 7583edc8..00000000 --- a/starters/notes/assets/media/book.svg +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/starters/notes/assets/media/covers/nasa-Q1p7bh3SHj8-unsplash.jpg b/starters/notes/assets/media/covers/nasa-Q1p7bh3SHj8-unsplash.jpg new file mode 100644 index 00000000..f62a692e Binary files /dev/null and b/starters/notes/assets/media/covers/nasa-Q1p7bh3SHj8-unsplash.jpg differ diff --git a/starters/notes/content/_index.md b/starters/notes/content/_index.md index 42ae115d..613da4b4 100644 --- a/starters/notes/content/_index.md +++ b/starters/notes/content/_index.md @@ -1,7 +1,11 @@ --- -title: Notes +title: ✍️ Notes type: book # Do not modify. toc: false + +cover: + image: covers/nasa-Q1p7bh3SHj8-unsplash.jpg + caption: NASA --- Welcome to the _Notes_ template! @@ -12,4 +16,17 @@ The **Notes** starter template empowers you to easily create **personal notes** - Supports audio, video, images, math, code, [Mermaid](https://mermaid.live/) diagrams, and [much more](https://wowchemy.com/docs/content/writing-markdown-latex/) - Edit your notes online in GitHub, or any Git-connected Markdown app such as [Obsidian](https://obsidian.md/) or [Visual Studio Code](https://vscode.dev/) -{{< cta cta_text="👉 Get Started with Chapter 1" cta_link="chapter1" >}} +## Public vs Private Second Brain + +Choose between **publishing and sharing your knowledge online or creating a private second brain**. + +To create an **open second brain**, share your notes as a website [by deploying the Note template](https://wowchemy.com/hugo-themes/). + +To create a **private second brain** either: + +- After deploying your Notes site above, [password protect your online second brain](https://docs.netlify.com/visitor-access/password-protection/) and configure your GitHub repo as **private** +- [Download this template](https://github.com/wowchemy/hugo-notes-theme) and [run the tool locally](https://wowchemy.com/docs/getting-started/install-hugo-extended/) + +## Example notebook + +{{< cta cta_text="👉 Check out the Machine Learning notebook" cta_link="machine-learning" >}} diff --git a/starters/notes/content/chapter2/_index.md b/starters/notes/content/chapter2/_index.md deleted file mode 100644 index a48d3027..00000000 --- a/starters/notes/content/chapter2/_index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -# Title, summary, and page position. -title: Chapter 2 -linktitle: Chapter 2 -summary: Learn how to use Academic's docs layout for publishing online courses, software documentation, and tutorials. -weight: 1 -icon: book-reader -icon_pack: fas - -# Page metadata. -date: '2018-09-09T00:00:00Z' -type: book # Do not modify. -toc: false ---- - -{{< list_children >}} diff --git a/starters/notes/content/chapter1/_index.md b/starters/notes/content/machine-learning/_index.md similarity index 75% rename from starters/notes/content/chapter1/_index.md rename to starters/notes/content/machine-learning/_index.md index da607e49..4501f399 100644 --- a/starters/notes/content/chapter1/_index.md +++ b/starters/notes/content/machine-learning/_index.md @@ -1,11 +1,11 @@ --- # Title, summary, and page position. -title: Chapter 1 -linktitle: Chapter 1 +title: 🤖 Machine Learning +linktitle: 🤖 Machine Learning summary: Learn how to use Wowchemy's docs layout for publishing online courses, software documentation, and tutorials. weight: 1 -icon: book -icon_pack: fas +# icon: book +# icon_pack: fas # Page metadata. date: '2018-09-09T00:00:00Z' diff --git a/starters/notes/content/chapter1/reading-list.md b/starters/notes/content/machine-learning/reading-list.md similarity index 100% rename from starters/notes/content/chapter1/reading-list.md rename to starters/notes/content/machine-learning/reading-list.md diff --git a/starters/notes/content/chapter1/syllabus.md b/starters/notes/content/machine-learning/syllabus.md similarity index 100% rename from starters/notes/content/chapter1/syllabus.md rename to starters/notes/content/machine-learning/syllabus.md diff --git a/starters/notes/content/chapter1/takeaways.md b/starters/notes/content/machine-learning/takeaways.md similarity index 100% rename from starters/notes/content/chapter1/takeaways.md rename to starters/notes/content/machine-learning/takeaways.md diff --git a/starters/notes/content/数据结构/_index.md b/starters/notes/content/数据结构/_index.md new file mode 100644 index 00000000..4623e637 --- /dev/null +++ b/starters/notes/content/数据结构/_index.md @@ -0,0 +1,16 @@ +--- +# Title, summary, and page position. +title: 数据结构 +linktitle: 数据结构 +summary: Notes on Python data structures. +weight: 2 +icon: python +icon_pack: fab + +# Page metadata. +date: '2018-09-09T00:00:00Z' +type: book # Do not modify. +toc: false +--- + +{{< list_children >}} diff --git a/starters/notes/content/chapter2/reading-list.md b/starters/notes/content/数据结构/reading-list.md similarity index 100% rename from starters/notes/content/chapter2/reading-list.md rename to starters/notes/content/数据结构/reading-list.md diff --git a/starters/notes/content/chapter2/syllabus.md b/starters/notes/content/数据结构/syllabus.md similarity index 100% rename from starters/notes/content/chapter2/syllabus.md rename to starters/notes/content/数据结构/syllabus.md diff --git a/starters/notes/content/chapter2/takeaways.md b/starters/notes/content/数据结构/takeaways.md similarity index 100% rename from starters/notes/content/chapter2/takeaways.md rename to starters/notes/content/数据结构/takeaways.md diff --git a/starters/notes/go.mod b/starters/notes/go.mod index f00d7cd3..a3aa2a07 100644 --- a/starters/notes/go.mod +++ b/starters/notes/go.mod @@ -3,6 +3,6 @@ module github.com/wowchemy/starter-book go 1.14 require ( - github.com/wowchemy/wowchemy-hugo-modules/wowchemy-cms/v5 v5.0.0-20220516122451-b804e4ab2fa6 // indirect - github.com/wowchemy/wowchemy-hugo-modules/wowchemy/v5 v5.0.0-20220516122451-b804e4ab2fa6 // indirect + github.com/wowchemy/wowchemy-hugo-modules/wowchemy-cms/v5 v5.0.0-20220516184432-2d2e58d8f4d3 // indirect + github.com/wowchemy/wowchemy-hugo-modules/wowchemy/v5 v5.0.0-20220516184432-2d2e58d8f4d3 // indirect ) diff --git a/starters/notes/preview.webp b/starters/notes/preview.webp index 7ae0e678..03a69b30 100644 Binary files a/starters/notes/preview.webp and b/starters/notes/preview.webp differ