diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index f2da7d4a..62fd3988 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -10,7 +10,7 @@ body: options: - label: I have [searched](https://github.com/wowchemy/wowchemy-hugo-themes/issues?q=is%3Aissue) for duplicate or closed feature requests required: true - - label: I am mindful of the project [scope](https://github.com/wowchemy/wowchemy-hugo-themes/blob/main/.github/contributing.md#scope) + - label: I am mindful of the project [scope](https://github.com/wowchemy/wowchemy-hugo-themes/blob/main/CONTRIBUTING.md#scope) required: true - type: textarea id: proposal diff --git a/.github/workflows/split-packages.yaml b/.github/workflows/split-packages.yaml index 11c7be40..ebd7a429 100644 --- a/.github/workflows/split-packages.yaml +++ b/.github/workflows/split-packages.yaml @@ -33,8 +33,8 @@ jobs: split_repository: 'hugo-minimal-theme' - local_path: 'research-group' split_repository: 'starter-hugo-research-group' - - local_path: 'notes' - split_repository: 'hugo-notes-theme' + - local_path: 'second-brain' + split_repository: 'hugo-second-brain-theme' steps: - uses: actions/checkout@v2 diff --git a/starters/markdown-slides/go.mod b/starters/markdown-slides/go.mod index 51888024..ef80a4bc 100644 --- a/starters/markdown-slides/go.mod +++ b/starters/markdown-slides/go.mod @@ -6,5 +6,5 @@ require ( github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy-plugin-netlify v1.0.0 // indirect github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy-plugin-netlify-cms v1.0.0 // indirect github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy-plugin-reveal v1.0.0 // indirect - github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5 v5.6.0 // indirect + github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5 v5.7.0 // indirect ) diff --git a/starters/notes/preview.webp b/starters/notes/preview.webp deleted file mode 100644 index 03a69b30..00000000 Binary files a/starters/notes/preview.webp and /dev/null differ diff --git a/starters/notes/.editorconfig b/starters/second-brain/.editorconfig similarity index 100% rename from starters/notes/.editorconfig rename to starters/second-brain/.editorconfig diff --git a/starters/notes/.github/FUNDING.yml b/starters/second-brain/.github/FUNDING.yml similarity index 100% rename from starters/notes/.github/FUNDING.yml rename to starters/second-brain/.github/FUNDING.yml diff --git a/starters/notes/.gitignore b/starters/second-brain/.gitignore similarity index 100% rename from starters/notes/.gitignore rename to starters/second-brain/.gitignore diff --git a/starters/notes/README.md b/starters/second-brain/README.md similarity index 89% rename from starters/notes/README.md rename to starters/second-brain/README.md index 8e5051f4..cb4bb374 100644 --- a/starters/notes/README.md +++ b/starters/second-brain/README.md @@ -1,8 +1,8 @@ -# [Hugo Obsidian Notes Theme](https://github.com/wowchemy/hugo-notes-theme) +# [Hugo Second Brain Theme](https://github.com/wowchemy/hugo-second-brain-theme) [![Screenshot](./preview.webp)](https://wowchemy.com/hugo-themes/) -The **Notes** starter template empowers you to easily create **personal notes** and **knowledge bases** in a future-proof way. +The **Second Brain** 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 - Supports audio, video, images, math, code, [Mermaid](https://mermaid.live/) diagrams, and [much more](https://wowchemy.com/docs/content/writing-markdown-latex/) @@ -22,7 +22,7 @@ The integrated [**Wowchemy**](https://wowchemy.com) website builder and CMS make - ⬇️ **Automatically import citations from BibTeX** with the [Hugo Academic CLI](https://github.com/wowchemy/hugo-academic-cli) - 🐦 Share your new site with the community: [@wowchemy](https://twitter.com/wowchemy) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithWowchemy](https://twitter.com/search?q=%23MadeWithWowchemy&src=typed_query) - 🗳 [Take the survey and help us improve #OpenSource](https://forms.gle/NioD9VhUg7PNmdCAA) -- 🚀 [Contribute improvements](https://github.com/wowchemy/wowchemy-hugo-themes/blob/main/.github/contributing.md) or [suggest improvements](https://github.com/wowchemy/wowchemy-hugo-themes/issues) +- 🚀 [Contribute improvements](https://github.com/wowchemy/wowchemy-hugo-themes/blob/main/CONTRIBUTING.md) or [suggest improvements](https://github.com/wowchemy/wowchemy-hugo-themes/issues) - ⬆️ **Updating?** View the [Update Guide](https://wowchemy.com/docs/hugo-tutorials/update/) and [Release Notes](https://github.com/wowchemy/wowchemy-hugo-themes/releases) ## We ask you, humbly, to support this open source movement diff --git a/starters/notes/assets/media/covers/nasa-Q1p7bh3SHj8-unsplash.jpg b/starters/second-brain/assets/media/covers/nasa-Q1p7bh3SHj8-unsplash.jpg similarity index 100% rename from starters/notes/assets/media/covers/nasa-Q1p7bh3SHj8-unsplash.jpg rename to starters/second-brain/assets/media/covers/nasa-Q1p7bh3SHj8-unsplash.jpg diff --git a/starters/second-brain/assets/media/icon.png b/starters/second-brain/assets/media/icon.png new file mode 100644 index 00000000..1699fee0 Binary files /dev/null and b/starters/second-brain/assets/media/icon.png differ diff --git a/starters/notes/assets/media/icons/.gitkeep b/starters/second-brain/assets/media/icons/.gitkeep similarity index 100% rename from starters/notes/assets/media/icons/.gitkeep rename to starters/second-brain/assets/media/icons/.gitkeep diff --git a/starters/notes/config/_default/config.yaml b/starters/second-brain/config/_default/config.yaml similarity index 99% rename from starters/notes/config/_default/config.yaml rename to starters/second-brain/config/_default/config.yaml index d914c30c..b665963b 100644 --- a/starters/notes/config/_default/config.yaml +++ b/starters/second-brain/config/_default/config.yaml @@ -14,6 +14,7 @@ cascade: # Docs folder options - _target: path: /** + type: book editable: true show_breadcrumb: true diff --git a/starters/notes/config/_default/menus.yaml b/starters/second-brain/config/_default/menus.yaml similarity index 100% rename from starters/notes/config/_default/menus.yaml rename to starters/second-brain/config/_default/menus.yaml diff --git a/starters/notes/config/_default/params.yaml b/starters/second-brain/config/_default/params.yaml similarity index 96% rename from starters/notes/config/_default/params.yaml rename to starters/second-brain/config/_default/params.yaml index 5d5a357c..ae24d0a4 100644 --- a/starters/notes/config/_default/params.yaml +++ b/starters/second-brain/config/_default/params.yaml @@ -65,7 +65,7 @@ features: privacy_pack: enable: false repository: - url: 'https://github.com/wowchemy/hugo-notes-theme' + url: 'https://github.com/wowchemy/hugo-second-brain-theme' content_dir: content branch: main comment: diff --git a/starters/second-brain/content/_index.md b/starters/second-brain/content/_index.md new file mode 100644 index 00000000..5e7fb71b --- /dev/null +++ b/starters/second-brain/content/_index.md @@ -0,0 +1,41 @@ +--- +title: ✍️ Second Brain +date: 2022-09-24 +toc: false + +image: + filename: covers/nasa-Q1p7bh3SHj8-unsplash.jpg + caption: NASA +--- + +Welcome to the _Second Brain_ template! + +The **Second Brain** 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 +- 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/) + +```markmap {height="200px"} +- Second Brain + - **powerful** knowledge base + - **easy**: just plain text Markdown files + - all your thoughts are **connected** + - highly **extensible** + - **future-proof** & open source ❤️ +``` + +## 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 knowledge with others [by deploying this template](https://wowchemy.com/hugo-themes/) as a public website. + +To create a **private second brain** either: + +- After deploying your 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-second-brain-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/machine-learning/_index.md b/starters/second-brain/content/machine-learning/_index.md similarity index 86% rename from starters/notes/content/machine-learning/_index.md rename to starters/second-brain/content/machine-learning/_index.md index 4501f399..c72d7c06 100644 --- a/starters/notes/content/machine-learning/_index.md +++ b/starters/second-brain/content/machine-learning/_index.md @@ -9,8 +9,5 @@ weight: 1 # Page metadata. date: '2018-09-09T00:00:00Z' -type: book # Do not modify. toc: false --- - -{{< list_children >}} diff --git a/starters/notes/content/数据结构/reading-list.md b/starters/second-brain/content/machine-learning/reading-list.md similarity index 99% rename from starters/notes/content/数据结构/reading-list.md rename to starters/second-brain/content/machine-learning/reading-list.md index e48c00df..c59300c4 100644 --- a/starters/notes/content/数据结构/reading-list.md +++ b/starters/second-brain/content/machine-learning/reading-list.md @@ -1,7 +1,6 @@ --- title: Reading List linktitle: Reading List -type: book date: '2019-05-05T00:00:00+01:00' # Prev/next pager order (if `docs_section_pager` enabled in `params.toml`) weight: 2 diff --git a/starters/notes/content/machine-learning/syllabus.md b/starters/second-brain/content/machine-learning/syllabus.md similarity index 99% rename from starters/notes/content/machine-learning/syllabus.md rename to starters/second-brain/content/machine-learning/syllabus.md index 8355fcaf..3fd42ac6 100644 --- a/starters/notes/content/machine-learning/syllabus.md +++ b/starters/second-brain/content/machine-learning/syllabus.md @@ -1,7 +1,6 @@ --- title: Syllabus linktitle: Syllabus -type: book date: '2019-05-05T00:00:00+01:00' # Prev/next pager order (if `docs_section_pager` enabled in `params.toml`) diff --git a/starters/notes/content/machine-learning/takeaways.md b/starters/second-brain/content/machine-learning/takeaways.md similarity index 99% rename from starters/notes/content/machine-learning/takeaways.md rename to starters/second-brain/content/machine-learning/takeaways.md index 51aa3598..c10e3695 100644 --- a/starters/notes/content/machine-learning/takeaways.md +++ b/starters/second-brain/content/machine-learning/takeaways.md @@ -1,7 +1,6 @@ --- title: Takeaways linktitle: Takeaways -type: book date: '2019-05-05T00:00:00+01:00' # Prev/next pager order (if `docs_section_pager` enabled in `params.toml`) diff --git a/starters/notes/content/数据结构/_index.md b/starters/second-brain/content/数据结构/_index.md similarity index 81% rename from starters/notes/content/数据结构/_index.md rename to starters/second-brain/content/数据结构/_index.md index 4623e637..f707f676 100644 --- a/starters/notes/content/数据结构/_index.md +++ b/starters/second-brain/content/数据结构/_index.md @@ -9,8 +9,5 @@ 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/machine-learning/reading-list.md b/starters/second-brain/content/数据结构/reading-list.md similarity index 99% rename from starters/notes/content/machine-learning/reading-list.md rename to starters/second-brain/content/数据结构/reading-list.md index e48c00df..c59300c4 100644 --- a/starters/notes/content/machine-learning/reading-list.md +++ b/starters/second-brain/content/数据结构/reading-list.md @@ -1,7 +1,6 @@ --- title: Reading List linktitle: Reading List -type: book date: '2019-05-05T00:00:00+01:00' # Prev/next pager order (if `docs_section_pager` enabled in `params.toml`) weight: 2 diff --git a/starters/notes/content/数据结构/syllabus.md b/starters/second-brain/content/数据结构/syllabus.md similarity index 99% rename from starters/notes/content/数据结构/syllabus.md rename to starters/second-brain/content/数据结构/syllabus.md index 8355fcaf..3fd42ac6 100644 --- a/starters/notes/content/数据结构/syllabus.md +++ b/starters/second-brain/content/数据结构/syllabus.md @@ -1,7 +1,6 @@ --- title: Syllabus linktitle: Syllabus -type: book date: '2019-05-05T00:00:00+01:00' # Prev/next pager order (if `docs_section_pager` enabled in `params.toml`) diff --git a/starters/notes/content/数据结构/takeaways.md b/starters/second-brain/content/数据结构/takeaways.md similarity index 99% rename from starters/notes/content/数据结构/takeaways.md rename to starters/second-brain/content/数据结构/takeaways.md index 44d1fa09..a9281d81 100644 --- a/starters/notes/content/数据结构/takeaways.md +++ b/starters/second-brain/content/数据结构/takeaways.md @@ -2,9 +2,7 @@ title: Takeaways linktitle: Takeaways toc: true -type: book date: '2019-05-05T00:00:00+01:00' -draft: true # Prev/next pager order (if `docs_section_pager` enabled in `params.toml`) weight: 3 diff --git a/starters/notes/go.mod b/starters/second-brain/go.mod similarity index 80% rename from starters/notes/go.mod rename to starters/second-brain/go.mod index 5d67a2cd..7108d075 100644 --- a/starters/notes/go.mod +++ b/starters/second-brain/go.mod @@ -1,9 +1,9 @@ -module github.com/wowchemy/hugo-notes-theme +module github.com/wowchemy/hugo-second-brain-theme go 1.15 require ( github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy-plugin-netlify v1.0.0 // indirect github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy-plugin-netlify-cms v1.0.0 // indirect - github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5 v5.6.0 // indirect + github.com/wowchemy/wowchemy-hugo-themes/modules/wowchemy/v5 v5.7.0 // indirect ) diff --git a/starters/notes/netlify.toml b/starters/second-brain/netlify.toml similarity index 100% rename from starters/notes/netlify.toml rename to starters/second-brain/netlify.toml diff --git a/starters/second-brain/preview.webp b/starters/second-brain/preview.webp new file mode 100644 index 00000000..9b4df676 Binary files /dev/null and b/starters/second-brain/preview.webp differ diff --git a/starters/notes/static/uploads/.gitkeep b/starters/second-brain/static/uploads/.gitkeep similarity index 100% rename from starters/notes/static/uploads/.gitkeep rename to starters/second-brain/static/uploads/.gitkeep