diff --git a/starters/landing-page/.github/preview.webp b/starters/landing-page/.github/preview.webp index fb2b7387..05b2f593 100644 Binary files a/starters/landing-page/.github/preview.webp and b/starters/landing-page/.github/preview.webp differ diff --git a/starters/landing-page/.github/workflows/publish.yaml b/starters/landing-page/.github/workflows/publish.yaml index 323e900d..e58fb6e6 100644 --- a/starters/landing-page/.github/workflows/publish.yaml +++ b/starters/landing-page/.github/workflows/publish.yaml @@ -51,6 +51,8 @@ jobs: run: | echo "Hugo Cache Dir: $(hugo config | grep cachedir)" hugo --minify --baseURL "${{ steps.pages.outputs.base_url }}/" + - name: Generate Pagefind search index + run: npx pagefind --source "public" - name: Upload artifact uses: actions/upload-pages-artifact@v2 with: diff --git a/starters/landing-page/assets/media/logo.svg b/starters/landing-page/assets/media/logo.svg new file mode 100644 index 00000000..4c856730 --- /dev/null +++ b/starters/landing-page/assets/media/logo.svg @@ -0,0 +1 @@ + diff --git a/starters/landing-page/config/_default/hugo.yaml b/starters/landing-page/config/_default/hugo.yaml index 515e307d..724d7b55 100644 --- a/starters/landing-page/config/_default/hugo.yaml +++ b/starters/landing-page/config/_default/hugo.yaml @@ -6,6 +6,20 @@ title: Creator's Landing Page | Hugo Theme # Website name baseURL: 'https://example.com/' # Website URL +############################ +## PAGE OPTIONS +############################ + +cascade: + # Blog post options + - _target: + path: /post/* + kind: section + # Change url to /blog/ + url: /blog/ + # Set the listing view + view: date-title-summary + ############################ ## LANGUAGE ############################ @@ -29,6 +43,7 @@ enableRobotsTXT: true footnotereturnlinkcontents: ^ ignoreFiles: [\.ipynb$, .ipynb_checkpoints$, \.Rmd$, \.Rmarkdown$, _cache$] permalinks: + post: '/blog/:slug/' authors: '/author/:slug/' tags: '/tag/:slug/' categories: '/category/:slug/' @@ -42,6 +57,8 @@ imaging: anchor: smart timeout: 600000 taxonomies: + tag: tags + category: categories author: authors markup: _merge: deep diff --git a/starters/landing-page/config/_default/menus.yaml b/starters/landing-page/config/_default/menus.yaml index 0f8c5ef8..65c22180 100644 --- a/starters/landing-page/config/_default/menus.yaml +++ b/starters/landing-page/config/_default/menus.yaml @@ -1,11 +1,10 @@ # Navigation Links -# To link a homepage widget, specify the URL as a hash `#` followed by the filename of the - # desired widget in your `content/home/` folder. - # The weight parameter defines the order that the links will appear in. +# To link a page section, specify the URL as a hash `/#` followed by the `id` of the section. +# The `weight` parameter defines the order that the links will appear in. main: - name: Home - url: / + url: /#top weight: 10 - name: Features url: /#features @@ -13,3 +12,9 @@ main: - name: Solutions url: /#solutions weight: 30 + - name: Resources + weight: 40 + hasChildren: true + - parent: Resources + name: Blog + url: blog/ diff --git a/starters/landing-page/config/_default/params.yaml b/starters/landing-page/config/_default/params.yaml index 04f0f21e..afcb8af2 100644 --- a/starters/landing-page/config/_default/params.yaml +++ b/starters/landing-page/config/_default/params.yaml @@ -30,8 +30,17 @@ marketing: header: navbar: enable: true - blox: navbar - show_search: false + blox: "navbar" + fixed_to_top: true + logo: + text: "" + # Logo filename in `assets/media/` folder + filename: "logo.svg" + button: + enable: true + text: "Get Started" + url: "https://hugoblox.com/templates/" + show_search: true show_theme_chooser: true # Site footer diff --git a/starters/landing-page/content/_index.md b/starters/landing-page/content/_index.md index 62fa13e1..9204368d 100644 --- a/starters/landing-page/content/_index.md +++ b/starters/landing-page/content/_index.md @@ -11,7 +11,7 @@ sections: primary_action: text: Get Started url: https://hugoblox.com/templates/ - icon: sparkles + icon: rocket-launch secondary_action: text: Read the docs url: https://docs.hugoblox.com @@ -19,7 +19,7 @@ sections: text: Announcing the release of version 1. link: text: Read more - url: https://hugoblox.com/blog/ + url: /blog/ design: css_class: dark background: @@ -42,7 +42,7 @@ sections: description: Super fast page load with Tailwind CSS and super fast site building with Hugo. - name: Easy icon: sparkles - description: Connecting with your friends and family as well as discovering new ones is easy with features like Groups. + description: One-click deployment to GitHub Pages. Have your new website live within 5 minutes! - name: No-Code icon: code-bracket description: Edit and design your site just using rich text (Markdown) and configurable YAML parameters. @@ -58,13 +58,23 @@ sections: items: - title: Build your future-proof website text: As easy as 1, 2, 3! + feature_icon: check + features: + - "Future-proof - edit your content in text files" + - "Website is generated by a single app, Hugo" + - "No JavaScript knowledge required" # Upload image to `assets/media/` and reference the filename here image: build-website.png button: text: Get Started url: https://hugoblox.com/templates/ - title: Large Community - text: Join our large community - ask questions and share your Hugo knowledge with others. + text: Join our large community on Discord - ask questions and get live responses + feature_icon: bolt + features: + - "Dedicated support channel" + - "3,000+ users on Discord" + - "Share your site and get feedback" # Upload image to `assets/media/` and reference the filename here image: coffee.jpg button: diff --git a/starters/landing-page/content/post/_index.md b/starters/landing-page/content/post/_index.md new file mode 100644 index 00000000..9bff67d5 --- /dev/null +++ b/starters/landing-page/content/post/_index.md @@ -0,0 +1,3 @@ +--- +title: Blog +--- diff --git a/starters/landing-page/content/post/data-visualization/featured.jpg b/starters/landing-page/content/post/data-visualization/featured.jpg new file mode 100644 index 00000000..8c97312b Binary files /dev/null and b/starters/landing-page/content/post/data-visualization/featured.jpg differ diff --git a/starters/landing-page/content/post/data-visualization/index.md b/starters/landing-page/content/post/data-visualization/index.md new file mode 100644 index 00000000..868ba49b --- /dev/null +++ b/starters/landing-page/content/post/data-visualization/index.md @@ -0,0 +1,155 @@ +--- +title: πŸ“ˆ Communicate your results effectively with the best data visualizations +summary: Use popular tools such as Plotly, Mermaid, and data frames. +date: 2023-10-25 +tags: + - Hugo + - Wowchemy + - 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. + +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! + +Save your Plotly JSON in your page folder, for example `line-chart.json`, and then add the `{{}}` shortcode where you would like the chart to appear. + +Demo: + +{{< chart data="line-chart" >}} + +You might also find the [Plotly JSON Editor](http://plotly-json-editor.getforge.io/) useful. + +## Diagrams + +Wowchemy supports the _Mermaid_ Markdown extension for diagrams. + +An example **flowchart**: + + ```mermaid + graph TD + A[Hard] -->|Text| B(Round) + B --> C{Decision} + C -->|One| D[Result 1] + C -->|Two| E[Result 2] + ``` + +renders as + +```mermaid +graph TD +A[Hard] -->|Text| B(Round) +B --> C{Decision} +C -->|One| D[Result 1] +C -->|Two| E[Result 2] +``` + +An example **sequence diagram**: + + ```mermaid + sequenceDiagram + Alice->>John: Hello John, how are you? + loop Healthcheck + John->>John: Fight against hypochondria + end + Note right of John: Rational thoughts! + John-->>Alice: Great! + John->>Bob: How about you? + Bob-->>John: Jolly good! + ``` + +renders as + +```mermaid +sequenceDiagram +Alice->>John: Hello John, how are you? +loop Healthcheck + John->>John: Fight against hypochondria +end +Note right of John: Rational thoughts! +John-->>Alice: Great! +John->>Bob: How about you? +Bob-->>John: Jolly good! +``` + +An example **class diagram**: + + ```mermaid + classDiagram + Class01 <|-- AveryLongClass : Cool + Class03 *-- Class04 + Class05 o-- Class06 + Class07 .. Class08 + Class09 --> C2 : Where am i? + Class09 --* C3 + Class09 --|> Class07 + Class07 : equals() + Class07 : Object[] elementData + Class01 : size() + Class01 : int chimp + Class01 : int gorilla + Class08 <--> C2: Cool label + ``` + +renders as + +```mermaid +classDiagram +Class01 <|-- AveryLongClass : Cool +Class03 *-- Class04 +Class05 o-- Class06 +Class07 .. Class08 +Class09 --> C2 : Where am i? +Class09 --* C3 +Class09 --|> Class07 +Class07 : equals() +Class07 : Object[] elementData +Class01 : size() +Class01 : int chimp +Class01 : int gorilla +Class08 <--> C2: Cool label +``` + +An example **state diagram**: + + ```mermaid + stateDiagram + [*] --> Still + Still --> [*] + Still --> Moving + Moving --> Still + Moving --> Crash + Crash --> [*] + ``` + +renders as + +```mermaid +stateDiagram +[*] --> Still +Still --> [*] +Still --> Moving +Moving --> Still +Moving --> Crash +Crash --> [*] +``` + +## Data Frames + +Save your spreadsheet as a CSV file in your page's folder and then render it by adding the _Table_ shortcode to your page: + +```go +{{}} +``` + +renders as + +{{< table path="results.csv" header="true" caption="Table 1: My results" >}} + +## Did you find this page helpful? Consider sharing it πŸ™Œ diff --git a/starters/landing-page/content/post/data-visualization/line-chart.json b/starters/landing-page/content/post/data-visualization/line-chart.json new file mode 100644 index 00000000..4307b4f8 --- /dev/null +++ b/starters/landing-page/content/post/data-visualization/line-chart.json @@ -0,0 +1,71 @@ +{ + "data": [ + { + "uid": "babced", + "fill": "tonexty", + "mode": "none", + "name": "Col2", + "type": "scatter", + "x": [ + "2000-01-01", + "2001-01-01", + "2002-01-01", + "2003-01-01", + "2004-01-01", + "2005-01-01", + "2006-01-01", + "2007-01-01", + "2008-01-01", + "2009-01-01", + "2010-01-01", + "2011-01-01", + "2012-01-01", + "2013-01-01", + "2014-01-01", + "2015-01-01", + "2016-01-01" + ], + "y": [ + "17087182", + "29354370", + "38760373", + "40912332", + "51611646", + "64780617", + "85507314", + "121892559", + "172338726", + "238027855", + "206956723", + "346004403", + "697089489", + "672985183", + "968882453", + "863105652", + "1068513050" + ], + "fillcolor": "rgb(224, 102, 102)" + } + ], + "layout": { + "title": "Total Number of Websites", + "width": 800, + "xaxis": { + "type": "date", + "range": [946702800000, 1451624400000], + "title": "Source: Scribblrs
Source: Internet Live Stats", + "showgrid": false, + "autorange": true, + "tickformat": "%Y" + }, + "yaxis": { + "type": "linear", + "range": [0, 1124750578.9473684], + "title": "", + "autorange": true + }, + "height": 500, + "autosize": false + }, + "frames": [] +} diff --git a/starters/landing-page/content/post/data-visualization/results.csv b/starters/landing-page/content/post/data-visualization/results.csv new file mode 100644 index 00000000..0630ed92 --- /dev/null +++ b/starters/landing-page/content/post/data-visualization/results.csv @@ -0,0 +1,4 @@ +customer_id, score +1,0 +2,0.5 +3,1 diff --git a/starters/landing-page/content/post/get-started/featured.jpg b/starters/landing-page/content/post/get-started/featured.jpg new file mode 100644 index 00000000..4d20ee1f Binary files /dev/null and b/starters/landing-page/content/post/get-started/featured.jpg differ diff --git a/starters/landing-page/content/post/get-started/index.md b/starters/landing-page/content/post/get-started/index.md new file mode 100644 index 00000000..aaa12c6c --- /dev/null +++ b/starters/landing-page/content/post/get-started/index.md @@ -0,0 +1,83 @@ +--- +title: πŸŽ‰ Easily create your own simple yet highly customizable blog +summary: Take full control of your personal brand and privacy by migrating away from the big tech platforms! +date: 2023-10-27 + +# Featured image +# Place an image named `featured.jpg/png` in this page's folder and customize its options here. +image: + caption: 'Image credit: [**Unsplash**](https://unsplash.com)' + +authors: + - admin + +tags: + - Academic + - Wowchemy + - Markdown +--- + +Welcome πŸ‘‹ + +## 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 +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) + +## 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) + +## 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/) + +As a token of appreciation for sponsoring, you can **unlock [these](https://hugoblox.com/sponsor/) awesome rewards and extra features πŸ¦„βœ¨** + +## Ecosystem + +- **[Bibtex To Markdown](https://github.com/GetRD/academic-file-converter):** Automatically import publications from BibTeX + +## Inspiration + +[Learn what other **creators**](https://hugoblox.com/creators/) are building with this template. + +## Features + +- **Page builder** - Create _anything_ with no-code [**blocks**](https://hugoblox.com/blocks/) and [**elements**](https://docs.hugoblox.com/reference/markdown/) +- **Edit any type of content** - Blog posts, publications, talks, slides, projects, and more! +- **Create content** in [**Markdown**](https://docs.hugoblox.com/reference/markdown/), [**Jupyter**](https://docs.hugoblox.com/getting-started/cms/), or [**RStudio**](https://docs.hugoblox.com/getting-started/cms/) +- **Plugin System** - Fully customizable [**color** and **font themes**](https://docs.hugoblox.com/getting-started/customize/) +- **Display Code and Math** - Code syntax highlighting and LaTeX math supported +- **Integrations** - [Google Analytics](https://analytics.google.com), [Disqus commenting](https://disqus.com), Maps, Contact Forms, and more! +- **Beautiful Site** - Simple and refreshing one-page design +- **Industry-Leading SEO** - Help get your website found on search engines and social media +- **Media Galleries** - Display your images and videos with captions in a customizable gallery +- **Mobile Friendly** - Look amazing on every screen with a mobile friendly version of your site +- **Multi-language** - 35+ language packs including English, δΈ­ζ–‡, and PortuguΓͺs +- **Multi-user** - Each author gets their own profile page +- **Privacy Pack** - Assists with GDPR +- **Stand Out** - Bring your site to life with animation, parallax backgrounds, and scroll effects +- **One-Click Deployment** - No servers. No databases. Only files. + +## 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. + +[Choose a stunning **theme** and **font**](https://docs.hugoblox.com/getting-started/customize/) for your site. Themes are fully customizable. + +## License + +Copyright 2016-present [George Cushen](https://georgecushen.com). + +Released under the [MIT](https://github.com/HugoBlox/hugo-blox-builder/blob/main/LICENSE.md) license. diff --git a/starters/landing-page/content/post/project-management/featured.jpg b/starters/landing-page/content/post/project-management/featured.jpg new file mode 100644 index 00000000..a9e0ac09 Binary files /dev/null and b/starters/landing-page/content/post/project-management/featured.jpg differ diff --git a/starters/landing-page/content/post/project-management/index.md b/starters/landing-page/content/post/project-management/index.md new file mode 100644 index 00000000..12534e1a --- /dev/null +++ b/starters/landing-page/content/post/project-management/index.md @@ -0,0 +1,92 @@ +--- +title: βœ… Manage your projects +summary: Easily manage your projects - create ideation mind maps, Gantt charts, todo lists, and more! +date: 2023-10-23 +tags: + - Wowchemy + - Markdown +image: + caption: 'Image credit: [**Unsplash**](https://unsplash.com)' +--- + +Easily manage your projects - create ideation mind maps, Gantt charts, todo lists, and more! + +## Ideation + +Wowchemy 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. + +Mindmaps can be created by simply writing the items as a Markdown list within the `markmap` code block, indenting each item to create as many sub-levels as you need: + +
+
+
+```markmap {height="200px"}
+- Hugo Modules
+  - wowchemy
+  - blox-plugins-netlify
+  - blox-plugins-netlify-cms
+  - blox-plugins-reveal
+```
+
+
+
+ +renders as + +```markmap {height="200px"} +- Hugo Modules + - wowchemy + - blox-plugins-netlify + - blox-plugins-netlify-cms + - blox-plugins-reveal +``` + +## Diagrams + +Wowchemy supports the _Mermaid_ Markdown extension for diagrams. + +An example **Gantt diagram**: + + ```mermaid + gantt + section Section + Completed :done, des1, 2014-01-06,2014-01-08 + Active :active, des2, 2014-01-07, 3d + Parallel 1 : des3, after des1, 1d + Parallel 2 : des4, after des1, 1d + Parallel 3 : des5, after des3, 1d + Parallel 4 : des6, after des4, 1d + ``` + +renders as + +```mermaid +gantt +section Section +Completed :done, des1, 2014-01-06,2014-01-08 +Active :active, des2, 2014-01-07, 3d +Parallel 1 : des3, after des1, 1d +Parallel 2 : des4, after des1, 1d +Parallel 3 : des5, after des3, 1d +Parallel 4 : des6, after des4, 1d +``` + +## Todo lists + +You can even write your todo lists in Markdown too: + +```markdown +- [x] Write math example + - [x] Write diagram example +- [ ] Do something else +``` + +renders as + +- [x] Write math example + - [x] Write diagram example +- [ ] Do something else + +## Did you find this page helpful? Consider sharing it πŸ™Œ diff --git a/starters/landing-page/content/post/second-brain/featured.jpg b/starters/landing-page/content/post/second-brain/featured.jpg new file mode 100644 index 00000000..93200485 Binary files /dev/null and b/starters/landing-page/content/post/second-brain/featured.jpg differ diff --git a/starters/landing-page/content/post/second-brain/index.md b/starters/landing-page/content/post/second-brain/index.md new file mode 100644 index 00000000..83fb3efc --- /dev/null +++ b/starters/landing-page/content/post/second-brain/index.md @@ -0,0 +1,136 @@ +--- +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 +tags: + - Second Brain + - Markdown +image: + caption: 'Image credit: [**Unsplash**](https://unsplash.com)' +--- + +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. + +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. + +With this open format, can even edit your mindmaps in other popular tools such as Obsidian. + +Simply insert a Markdown code block labelled as `markmap` and optionally set the height of the mindmap as shown in the example below. + +Mindmaps can be created by simply writing the items as a Markdown list within the `markmap` code block, indenting each item to create as many sub-levels as you need: + +
+
+
+```markmap {height="200px"}
+- Hugo Modules
+  - wowchemy
+  - blox-plugins-netlify
+  - blox-plugins-netlify-cms
+  - blox-plugins-reveal
+```
+
+
+
+ +renders as + +```markmap {height="200px"} +- Hugo Modules + - wowchemy + - blox-plugins-netlify + - blox-plugins-netlify-cms + - blox-plugins-reveal +``` + +Anh here's a more advanced mindmap with formatting, code blocks, and math: + +
+
+
+```markmap
+- Mindmaps
+  - Links
+    - [Wowchemy Docs](https://docs.hugoblox.com/)
+    - [Discord Community](https://discord.gg/z8wNYzb)
+    - [GitHub](https://github.com/HugoBlox/hugo-blox-builder)
+  - Features
+    - Markdown formatting
+    - **inline** ~~text~~ *styles*
+    - multiline
+      text
+    - `inline code`
+    -
+      ```js
+      console.log('hello');
+      console.log('code block');
+      ```
+    - Math: $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$
+```
+
+
+
+ +renders as + +```markmap +- Mindmaps + - Links + - [Wowchemy Docs](https://docs.hugoblox.com/) + - [Discord Community](https://discord.gg/z8wNYzb) + - [GitHub](https://github.com/HugoBlox/hugo-blox-builder) + - Features + - Markdown formatting + - **inline** ~~text~~ *styles* + - multiline + text + - `inline code` + - + ```js + console.log('hello'); + console.log('code block'); + ``` + - Math: $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$ +``` + +## Highlighting + +Highlight important text with `mark`: + +```html +Highlighted text +``` + +## Callouts + +Use [callouts](https://docs.hugoblox.com/reference/markdown/#callouts) (aka _asides_, _hints_, or _alerts_) to draw attention to notes, tips, and warnings. + +By wrapping a paragraph in `{{%/* callout note */%}} ... {{%/* /callout */%}}`, it will render as an aside. + +```markdown +{{%/* callout note */%}} +A Markdown aside is useful for displaying notices, hints, or definitions to your readers. +{{%/* /callout */%}} +``` + +renders as + +{{% callout note %}} +A Markdown aside is useful for displaying notices, hints, or definitions to your readers. +{{% /callout %}} + +Or use the `warning` callout type so your readers don't miss critical details: + +{{% callout warning %}} +A Markdown aside is useful for displaying notices, hints, or definitions to your readers. +{{% /callout %}} + +## Did you find this page helpful? Consider sharing it πŸ™Œ diff --git a/starters/landing-page/content/post/teach-courses/ambient-piano.mp3 b/starters/landing-page/content/post/teach-courses/ambient-piano.mp3 new file mode 100644 index 00000000..8795f38d Binary files /dev/null and b/starters/landing-page/content/post/teach-courses/ambient-piano.mp3 differ diff --git a/starters/landing-page/content/post/teach-courses/featured.jpg b/starters/landing-page/content/post/teach-courses/featured.jpg new file mode 100644 index 00000000..5b053933 Binary files /dev/null and b/starters/landing-page/content/post/teach-courses/featured.jpg differ diff --git a/starters/landing-page/content/post/teach-courses/index.md b/starters/landing-page/content/post/teach-courses/index.md new file mode 100644 index 00000000..c28f3ac6 --- /dev/null +++ b/starters/landing-page/content/post/teach-courses/index.md @@ -0,0 +1,141 @@ +--- +title: πŸ‘©πŸΌβ€πŸ« Teach academic courses +summary: Embed videos, podcasts, code, LaTeX math, and even test students! +date: 2023-10-24 +math: true +tags: + - Hugo + - Hugo Blox Builder + - Markdown +image: + caption: 'Embed rich media such as videos and LaTeX math' +--- + +[Hugo Blox Builder](https://hugoblox.com) is designed to give technical content creators a seamless experience. You can focus on the content and the Hugo Blox Builder which this template is built upon handles the rest. + +**Embed videos, podcasts, code, LaTeX math, and even test students!** + +On this page, you'll find some examples of the types of technical content that can be rendered with Hugo Blox. + +## Video + +Teach your course by sharing videos with your students. Choose from one of the following approaches: + +{{< youtube D2vj0WcvH5c >}} + +**Youtube**: + + {{}} + +**Bilibili**: + + {{}} + +**Video file** + +Videos may be added to a page by either placing them in your `assets/media/` media library or in your [page's folder](https://gohugo.io/content-management/page-bundles/), and then embedding them with the _video_ shortcode: + + {{}} + +## Podcast + +You can add a podcast or music to a page by placing the MP3 file in the page's folder or the media library folder and then embedding the audio on your page with the _audio_ shortcode: + + {{}} + +Try it out: + +{{< audio src="ambient-piano.mp3" >}} + +## Test students + +Provide a simple yet fun self-assessment by revealing the solutions to challenges with the `spoiler` shortcode: + +```markdown +{{}} +You found me! +{{}} +``` + +renders as + +{{< spoiler text="πŸ‘‰ Click to view the solution" >}} You found me πŸŽ‰ {{< /spoiler >}} + +## 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. + +To render _inline_ or _block_ math, wrap your LaTeX math with `{{}}$...${{}}` or `{{}}$$...$${{}}`, respectively. + +{{% callout note %}} +We wrap the LaTeX math in the Hugo Blox _math_ shortcode to prevent Hugo rendering our math as Markdown. +{{% /callout %}} + +Example **math block**: + +```latex +{{}} +$$ +\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} +$$ +{{}} +``` + +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** `{{}}$\nabla F(\mathbf{x}_{n})${{}}` renders as {{< math >}}$\nabla F(\mathbf{x}_{n})${{< /math >}}. + +Example **multi-line math** using the math linebreak (`\\`): + +```latex +{{}} +$$f(k;p_{0}^{*}) = \begin{cases}p_{0}^{*} & \text{if }k=1, \\ +1-p_{0}^{*} & \text{if }k=0.\end{cases}$$ +{{}} +``` + +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. + + + ```python + import pandas as pd + data = pd.read_csv("data.csv") + data.head() + ``` + +renders as + +```python +import pandas as pd +data = pd.read_csv("data.csv") +data.head() +``` + +## Inline Images + +```go +{{}} Python +``` + +renders as + +{{< icon name="python" >}} Python + +## Did you find this page helpful? Consider sharing it πŸ™Œ diff --git a/starters/landing-page/go.mod b/starters/landing-page/go.mod index 5fac6f15..6e134695 100644 --- a/starters/landing-page/go.mod +++ b/starters/landing-page/go.mod @@ -4,5 +4,5 @@ go 1.19 require ( github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify v1.1.2-0.20231108143325-448ed0e3bd2b - github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.1.2-0.20231205221046-e29517634e3b + github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind v0.1.2-0.20231214235519-5a4b7ec72168 )