Skip to content

Commit

Permalink
starters: update
Browse files Browse the repository at this point in the history
  • Loading branch information
gcushen committed Jun 2, 2024
1 parent 492e343 commit 676a1b2
Show file tree
Hide file tree
Showing 32 changed files with 80 additions and 71 deletions.
2 changes: 1 addition & 1 deletion starters/academic-cv/.github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Deploy website to GitHub Pages

env:
WC_HUGO_VERSION: '0.126.1'
WC_HUGO_VERSION: '0.126.3'

on:
# Trigger the workflow every time you push to the `main` branch
Expand Down
12 changes: 7 additions & 5 deletions starters/academic-cv/content/post/data-visualization/index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
---
title: 📈 Communicate your results effectively with the best data visualizations
summary: Use popular tools such as Plotly, Mermaid, and data frames.
date: 2023-10-26
date: 2023-10-25
authors:
- admin
tags:
- Hugo
- Wowchemy
- Hugo Blox
- Markdown
image:
caption: 'Image credit: [**Unsplash**](https://unsplash.com)'
---

Wowchemy is designed to give technical content creators a seamless experience. You can focus on the content and Wowchemy handles the rest.
Hugo Blox is designed to give technical content creators a seamless experience. You can focus on the content and Hugo Blox handles the rest.

Use popular tools such as Plotly, Mermaid, and data frames.

## Charts

Wowchemy supports the popular [Plotly](https://plot.ly/) format for interactive data visualizations. With Plotly, you can design almost any kind of visualization you can imagine!
Hugo Blox supports the popular [Plotly](https://plot.ly/) format for interactive data visualizations. With Plotly, you can design almost any kind of visualization you can imagine!

Save your Plotly JSON in your page folder, for example `line-chart.json`, and then add the `{{</* chart data="line-chart" */>}}` shortcode where you would like the chart to appear.

Expand All @@ -28,7 +30,7 @@ You might also find the [Plotly JSON Editor](http://plotly-json-editor.getforge.

## Diagrams

Wowchemy supports the _Mermaid_ Markdown extension for diagrams.
Hugo Blox supports the _Mermaid_ Markdown extension for diagrams.

An example **flowchart**:

Expand Down
23 changes: 13 additions & 10 deletions starters/academic-cv/content/post/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,40 @@ image:

authors:
- admin
- Ted

tags:
- Academic
- Wowchemy
- Hugo Blox
- Markdown
---

Welcome 👋

{{< toc mobile_only=true is_open=true >}}

## Overview

1. The Wowchemy website builder for Hugo, along with its starter templates, is designed for professional creators, educators, and teams/organizations - although it can be used to create any kind of site
1. The Hugo Blox website builder for Hugo, along with its starter templates, is designed for professional creators, educators, and teams/organizations - although it can be used to create any kind of site
2. The template can be modified and customised to suit your needs. It's a good platform for anyone looking to take control of their data and online identity whilst having the convenience to start off with a **no-code solution (write in Markdown and customize with YAML parameters)** and having **flexibility to later add even deeper personalization with HTML and CSS**
3. You can work with all your favourite tools and apps with hundreds of plugins and integrations to speed up your workflows, interact with your readers, and much more

[![The template is mobile first with a responsive design to ensure that your site looks stunning on every device.](https://raw.githubusercontent.com/wowchemy/wowchemy-hugo-modules/main/starters/academic/preview.png)](https://hugoblox.com)
[//]: # ([![The template is mobile first with a responsive design to ensure that your site looks stunning on every device.]&#40;https://raw.githubusercontent.com/wowchemy/wowchemy-hugo-modules/main/starters/academic/preview.png&#41;]&#40;https://hugoblox.com&#41;)

## Get Started
### Get Started

- 👉 [**Create a new site**](https://hugoblox.com/templates/)
- 📚 [**Personalize your site**](https://docs.hugoblox.com/)
- 💬 [Chat with the **Wowchemy community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
- 🐦 Twitter: [@wowchemy](https://twitter.com/wowchemy) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithWowchemy](https://twitter.com/search?q=%23MadeWithWowchemy&src=typed_query)
- 💡 [Request a **feature** or report a **bug** for _Wowchemy_](https://github.com/HugoBlox/hugo-blox-builder/issues)
- ⬆️ **Updating Wowchemy?** View the [Update Guide](https://docs.hugoblox.com/reference/update/) and [Release Notes](https://github.com/HugoBlox/hugo-blox-builder/releases)
- 💬 [Chat with the **Hugo Blox community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
- 🐦 Twitter: [@GetResearchDev](https://twitter.com/GetResearchDev) [@GeorgeCushen](https://twitter.com/GeorgeCushen) #MadeWithHugoBlox
- 💡 [Request a **feature** or report a **bug** for _Hugo Blox_](https://github.com/HugoBlox/hugo-blox-builder/issues)
- ⬆️ **Updating Hugo Blox?** View the [Update Guide](https://docs.hugoblox.com/reference/update/) and [Release Notes](https://github.com/HugoBlox/hugo-blox-builder/releases)

## Crowd-funded open-source software

To help us develop this template and software sustainably under the MIT license, we ask all individuals and businesses that use it to help support its ongoing maintenance and development via sponsorship.

### [❤️ Click here to become a sponsor and help support Wowchemy's future ❤️](https://hugoblox.com/sponsor/)
### [❤️ Click here to become a sponsor and help support Hugo Blox's future ❤️](https://hugoblox.com/sponsor/)

As a token of appreciation for sponsoring, you can **unlock [these](https://hugoblox.com/sponsor/) awesome rewards and extra features 🦄✨**

Expand Down Expand Up @@ -72,7 +75,7 @@ As a token of appreciation for sponsoring, you can **unlock [these](https://hugo

## Themes

Wowchemy and its templates come with **automatic day (light) and night (dark) mode** built-in. Visitors can choose their preferred mode by clicking the sun/moon icon in the header.
Hugo Blox and its templates come with **automatic day (light) and night (dark) mode** built-in. Visitors can choose their preferred mode by clicking the sun/moon icon in the header.

[Choose a stunning **theme** and **font**](https://docs.hugoblox.com/getting-started/customize/) for your site. Themes are fully customizable.

Expand Down
12 changes: 7 additions & 5 deletions starters/academic-cv/content/post/project-management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
title: ✅ Manage your projects
summary: Easily manage your projects - create ideation mind maps, Gantt charts, todo lists, and more!
date: 2023-10-23
authors:
- admin
tags:
- Wowchemy
- Hugo Blox
- Markdown
image:
caption: 'Image credit: [**Unsplash**](https://unsplash.com)'
Expand All @@ -13,7 +15,7 @@ Easily manage your projects - create ideation mind maps, Gantt charts, todo list

## Ideation

Wowchemy supports a Markdown extension for mindmaps.
Hugo Blox supports a Markdown extension for mindmaps.

Simply insert a Markdown code block labelled as `markmap` and optionally set the height of the mindmap as shown in the example below.

Expand All @@ -24,7 +26,7 @@ Mindmaps can be created by simply writing the items as a Markdown list within th
<code>
```markmap {height="200px"}
- Hugo Modules
- wowchemy
- Hugo Blox
- blox-plugins-netlify
- blox-plugins-netlify-cms
- blox-plugins-reveal
Expand All @@ -37,15 +39,15 @@ renders as

```markmap {height="200px"}
- Hugo Modules
- wowchemy
- Hugo Blox
- blox-plugins-netlify
- blox-plugins-netlify-cms
- blox-plugins-reveal
```

## Diagrams

Wowchemy supports the _Mermaid_ Markdown extension for diagrams.
Hugo Blox supports the _Mermaid_ Markdown extension for diagrams.

An example **Gantt diagram**:

Expand Down
14 changes: 8 additions & 6 deletions starters/academic-cv/content/post/second-brain/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: 🧠 Sharpen your thinking with a second brain
summary: Create a personal knowledge base and share your knowledge with your peers.
date: 2023-10-26
authors:
- admin
tags:
- Second Brain
- Markdown
Expand All @@ -11,15 +13,15 @@ image:

Create a personal knowledge base and share your knowledge with your peers.

Wowchemy web framework empowers you with one of the most flexible note-taking capabilities out there.
Hugo Blox web framework empowers you with one of the most flexible note-taking capabilities out there.

Create a powerful knowledge base that works on top of a local folder of plain text Markdown files.

Use it as your second brain, either publicly sharing your knowledge with your peers via your website, or via a private GitHub repository and password-protected site just for yourself.

## Mindmaps

Wowchemy supports a Markdown extension for mindmaps.
Hugo Blox supports a Markdown extension for mindmaps.

With this open format, can even edit your mindmaps in other popular tools such as Obsidian.

Expand All @@ -32,7 +34,7 @@ Mindmaps can be created by simply writing the items as a Markdown list within th
<code>
```markmap {height="200px"}
- Hugo Modules
- wowchemy
- Hugo Blox
- blox-plugins-netlify
- blox-plugins-netlify-cms
- blox-plugins-reveal
Expand All @@ -45,7 +47,7 @@ renders as

```markmap {height="200px"}
- Hugo Modules
- wowchemy
- Hugo Blox
- blox-plugins-netlify
- blox-plugins-netlify-cms
- blox-plugins-reveal
Expand All @@ -59,7 +61,7 @@ Anh here's a more advanced mindmap with formatting, code blocks, and math:
```markmap
- Mindmaps
- Links
- [Wowchemy Docs](https://docs.hugoblox.com/)
- [Hugo Blox Docs](https://docs.hugoblox.com/)
- [Discord Community](https://discord.gg/z8wNYzb)
- [GitHub](https://github.com/HugoBlox/hugo-blox-builder)
- Features
Expand All @@ -84,7 +86,7 @@ renders as
```markmap
- Mindmaps
- Links
- [Wowchemy Docs](https://docs.hugoblox.com/)
- [Hugo Blox Docs](https://docs.hugoblox.com/)
- [Discord Community](https://discord.gg/z8wNYzb)
- [GitHub](https://github.com/HugoBlox/hugo-blox-builder)
- Features
Expand Down
36 changes: 16 additions & 20 deletions starters/academic-cv/content/post/teach-courses/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: 👩🏼‍🏫 Teach academic courses
summary: Embed videos, podcasts, code, LaTeX math, and even test students!
date: 2023-10-24
math: true
authors:
- admin
tags:
- Hugo
- Hugo Blox Builder
Expand All @@ -21,15 +23,17 @@ On this page, you'll find some examples of the types of technical content that c

Teach your course by sharing videos with your students. Choose from one of the following approaches:

{{< youtube D2vj0WcvH5c >}}

**Youtube**:

{{</* youtube w7Ft2ymGmfc */>}}
{{</* youtube D2vj0WcvH5c */>}}

{{< youtube D2vj0WcvH5c >}}

**Bilibili**:

{{</* bilibili id="BV1WV4y1r7DF" */>}}
{{</* bilibili BV1WV4y1r7DF */>}}

{{< bilibili BV1WV4y1r7DF >}}

**Video file**

Expand Down Expand Up @@ -63,52 +67,44 @@ renders as

## Math

Hugo Blox Builder supports a Markdown extension for $\LaTeX$ math. You can enable this feature by toggling the `math` option in your `config/_default/params.yaml` file.
Hugo Blox Builder supports a Markdown extension for $\LaTeX$ math. Enable math by setting the `math: true` option in your page's front matter, or enable math for your entire site by toggling math in your `config/_default/params.yaml` file:

To render _inline_ or _block_ math, wrap your LaTeX math with `{{</* math */>}}$...${{</* /math */>}}` or `{{</* math */>}}$$...$${{</* /math */>}}`, respectively.
```yaml
features:
math:
enable: true
```
{{% callout note %}}
We wrap the LaTeX math in the Hugo Blox _math_ shortcode to prevent Hugo rendering our math as Markdown.
{{% /callout %}}
To render _inline_ or _block_ math, wrap your LaTeX math with `$...$` or `$$...$$`, respectively.

Example **math block**:

```latex
{{</* math */>}}
$$
\gamma_{n} = \frac{ \left | \left (\mathbf x_{n} - \mathbf x_{n-1} \right )^T \left [\nabla F (\mathbf x_{n}) - \nabla F (\mathbf x_{n-1}) \right ] \right |}{\left \|\nabla F(\mathbf{x}_{n}) - \nabla F(\mathbf{x}_{n-1}) \right \|^2}
$$
{{</* /math */>}}
```

renders as

{{< math >}}
$$\gamma_{n} = \frac{ \left | \left (\mathbf x_{n} - \mathbf x_{n-1} \right )^T \left [\nabla F (\mathbf x_{n}) - \nabla F (\mathbf x_{n-1}) \right ] \right |}{\left \|\nabla F(\mathbf{x}_{n}) - \nabla F(\mathbf{x}_{n-1}) \right \|^2}$$
{{< /math >}}

Example **inline math** `{{</* math */>}}$\nabla F(\mathbf{x}_{n})${{</* /math */>}}` renders as {{< math >}}$\nabla F(\mathbf{x}_{n})${{< /math >}}.
Example **inline math** `$\nabla F(\mathbf{x}_{n})$` renders as $\nabla F(\mathbf{x}_{n})$.

Example **multi-line math** using the math linebreak (`\\`):

```latex
{{</* math */>}}
$$f(k;p_{0}^{*}) = \begin{cases}p_{0}^{*} & \text{if }k=1, \\
1-p_{0}^{*} & \text{if }k=0.\end{cases}$$
{{</* /math */>}}
```

renders as

{{< math >}}

$$
f(k;p_{0}^{*}) = \begin{cases}p_{0}^{*} & \text{if }k=1, \\
1-p_{0}^{*} & \text{if }k=0.\end{cases}
$$

{{< /math >}}

## Code

Hugo Blox Builder utilises Hugo's Markdown extension for highlighting code syntax. The code theme can be selected in the `config/_default/params.yaml` file.
Expand Down
2 changes: 1 addition & 1 deletion starters/academic-cv/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ go 1.19

require (
github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify v1.1.2-0.20231209203044-d31adfedd40b
github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.2.1-0.20240519161223-50c6efcd67ff
github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.2.1-0.20240602133901-492e343c2a33
)
2 changes: 1 addition & 1 deletion starters/academic-cv/hugoblox.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
build:
hugo_version: '0.126.1'
hugo_version: '0.126.3'
2 changes: 1 addition & 1 deletion starters/academic-cv/netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
publish = "public"

[build.environment]
HUGO_VERSION = "0.126.1"
HUGO_VERSION = "0.126.3"
HUGO_ENABLEGITINFO = "true"

[context.production.environment]
Expand Down
2 changes: 1 addition & 1 deletion starters/blog/.github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Deploy website to GitHub Pages

env:
WC_HUGO_VERSION: '0.126.1'
WC_HUGO_VERSION: '0.126.3'

on:
# Trigger the workflow every time you push to the `main` branch
Expand Down
2 changes: 2 additions & 0 deletions starters/blog/content/blog/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ tags:

Welcome 👋

{{< toc mobile_only=true is_open=true >}}

## Overview

1. The Hugo Blox website builder for Hugo, along with its starter templates, is designed for professional creators, educators, and teams/organizations - although it can be used to create any kind of site
Expand Down
2 changes: 1 addition & 1 deletion starters/blog/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ go 1.19

require (
github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify v1.1.2-0.20231125204555-f431a4a2c705
github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.2.1-0.20240519161223-50c6efcd67ff
github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.2.1-0.20240602133901-492e343c2a33
)
2 changes: 1 addition & 1 deletion starters/blog/hugoblox.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
build:
hugo_version: '0.126.1'
hugo_version: '0.126.3'
2 changes: 1 addition & 1 deletion starters/blog/netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
publish = "public"

[build.environment]
HUGO_VERSION = "0.126.1"
HUGO_VERSION = "0.126.3"
GO_VERSION = "1.21.5"
NODE_VERSION = "21.1.0"
HUGO_ENABLEGITINFO = "true"
Expand Down
2 changes: 1 addition & 1 deletion starters/documentation/.github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Deploy website to GitHub Pages

env:
WC_HUGO_VERSION: '0.126.1'
WC_HUGO_VERSION: '0.126.3'

on:
# Trigger the workflow every time you push to the `main` branch
Expand Down
2 changes: 1 addition & 1 deletion starters/documentation/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ go 1.15

require (
github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify v1.1.2-0.20240217212918-ae7f0c597978
github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.2.1-0.20240519161223-50c6efcd67ff
github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.2.1-0.20240602133901-492e343c2a33
)
2 changes: 1 addition & 1 deletion starters/documentation/hugoblox.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
build:
hugo_version: '0.126.1'
hugo_version: '0.126.3'
2 changes: 1 addition & 1 deletion starters/documentation/netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
publish = "public"

[build.environment]
HUGO_VERSION = "0.126.1"
HUGO_VERSION = "0.126.3"
HUGO_ENABLEGITINFO = "true"

[context.production.environment]
Expand Down
Loading

0 comments on commit 676a1b2

Please sign in to comment.