Skip to content

Commit

Permalink
starters(notes): add Cover image
Browse files Browse the repository at this point in the history
  • Loading branch information
gcushen committed May 16, 2022
1 parent 2d2e58d commit aa03201
Show file tree
Hide file tree
Showing 17 changed files with 48 additions and 27 deletions.
1 change: 1 addition & 0 deletions package.json
Expand Up @@ -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 ./..."
}
}
5 changes: 5 additions & 0 deletions scripts/update-starter.sh
@@ -0,0 +1,5 @@
#!/usr/bin/env zsh

cd "starters/$1"
hugo mod get -u ./...
cd ../..
2 changes: 1 addition & 1 deletion starters/notes/README.md
Expand Up @@ -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/)

Expand Down
2 changes: 0 additions & 2 deletions starters/notes/assets/media/book.svg

This file was deleted.

Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 19 additions & 2 deletions 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!
Expand All @@ -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" >}}
16 changes: 0 additions & 16 deletions starters/notes/content/chapter2/_index.md

This file was deleted.

@@ -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'
Expand Down
File renamed without changes.
16 changes: 16 additions & 0 deletions 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 >}}
4 changes: 2 additions & 2 deletions starters/notes/go.mod
Expand Up @@ -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
)
Binary file modified starters/notes/preview.webp
Binary file not shown.

0 comments on commit aa03201

Please sign in to comment.