Ver código fonte

feat(tpl): add Markdown Slides Starter

George Cushen 3 anos atrás
pai
commit
619dbfd16f

+ 1 - 0
.gitignore

@@ -9,6 +9,7 @@
 node_modules/
 
 # Hugo
+.hugo_build.lock
 resources/
 public/
 

+ 66 - 0
starters/markdown-slides/config/_default/config.yaml

@@ -0,0 +1,66 @@
+# Configuration of Hugo
+# Guide: https://wowchemy.com/docs/getting-started/
+# Hugo Documentation: https://gohugo.io/getting-started/configuration/#all-configuration-settings
+# This file is formatted using YAML syntax - learn more at https://learnxinyminutes.com/docs/yaml/
+
+title: Markdown Slides # Website name
+baseurl: 'https://example.com/' # Website URL
+copyright: '' # Footer text, e.g. '© {year} Me'
+
+############################
+## LANGUAGE
+############################
+
+languageCode: en-us
+hasCJKLanguage: false
+defaultContentLanguageInSubdir: false
+removePathAccents: true
+
+############################
+## MODULES
+############################
+
+module:
+  imports:
+    - path: github.com/wowchemy/wowchemy-hugo-modules/wowchemy-cms/v5
+    - path: github.com/wowchemy/wowchemy-hugo-modules/wowchemy/v5
+
+############################
+## ADVANCED
+############################
+
+enableGitInfo: false
+summaryLength: 30
+paginate: 10
+enableEmoji: true
+enableRobotsTXT: true
+footnotereturnlinkcontents: <sup>^</sup>
+ignoreFiles: [\.ipynb$, .ipynb_checkpoints$, \.Rmd$, \.Rmarkdown$, _cache$]
+permalinks:
+  tags: '/tag/:slug/'
+  categories: '/category/:slug/'
+disableAliases: true
+outputs:
+  home: [HTML, RSS, JSON, WebAppManifest, headers, redirects]
+  section: [HTML, RSS]
+imaging:
+  resampleFilter: lanczos
+  quality: 75
+  anchor: smart
+timeout: 600000
+taxonomies:
+  tag: tags
+  category: categories
+markup:
+  _merge: deep
+related:
+  threshold: 80
+  includeNewer: true
+  toLower: true
+  indices:
+    - name: tags
+      weight: 100
+    - name: categories
+      weight: 70
+security:
+  _merge: deep

+ 46 - 0
starters/markdown-slides/config/_default/params.yaml

@@ -0,0 +1,46 @@
+# SITE SETUP
+# Guide: https://wowchemy.com/docs/getting-started/customization/
+# Documentation: https://wowchemy.com/docs/
+# This file is formatted using YAML syntax - learn more at https://learnxinyminutes.com/docs/yaml/
+
+# Appearance
+
+theme: minimal
+day_night: true
+font: ''
+font_size: L
+
+# SEO
+
+site_type: Person
+local_business_type: ''
+org_name: ''
+description: ''
+twitter: ''
+
+# Site header
+
+main_menu:
+  enable: false
+
+# Localization
+
+locale:
+  date_format: 'Jan 2, 2006'
+  time_format: '3:04 PM'
+
+# Site features
+
+privacy_pack: false
+copyright_license:
+  enable: false
+  allow_derivatives: false
+  share_alike: true
+  allow_commercial: false
+  notice: 'This work is licensed under {license}'
+marketing:
+  google_analytics: ''
+  google_tag_manager: ''
+  google_site_verification: ''
+  baidu_site_verification: ''
+  baidu_tongji: ''

+ 7 - 0
starters/markdown-slides/content/admin/index.md

@@ -0,0 +1,7 @@
+---
+# Generate Wowchemy CMS
+type: wowchemycms
+outputs:
+- wowchemycms_config
+- HTML
+---

+ 7 - 0
starters/markdown-slides/content/home/index.md

@@ -0,0 +1,7 @@
+---
+# Homepage
+type: widget_page
+
+# Homepage is headless, other widget pages are not.
+headless: true
+---

+ 40 - 0
starters/markdown-slides/content/home/slides.md

@@ -0,0 +1,40 @@
+---
+# An instance of the Pages widget.
+# Documentation: https://wowchemy.com/docs/page-builder/
+widget: pages
+
+# This file represents a page section.
+headless: true
+
+# Order that this section appears on the page.
+weight: 20
+
+title:
+subtitle:
+
+content:
+  # Filter on criteria
+  filters:
+    folders:
+      - slides
+    tag: ''
+    category: ''
+    publication_type: ''
+    author: ''
+    exclude_featured: false
+    exclude_future: false
+    exclude_past: false
+  # Choose how many pages you would like to display (0 = all pages)
+  count: 0
+  # Choose how many pages you would like to offset by
+  offset: 0
+  # Page order: descending (desc) or ascending (asc) date.
+  order: desc
+
+design:
+  # Choose a view for the listings:
+  view: card
+  columns: '1'
+  spacing:
+    padding: ['3rem', 0, '2rem', 0]
+---

+ 29 - 0
starters/markdown-slides/content/home/tags.md

@@ -0,0 +1,29 @@
+---
+# An instance of the Tag Cloud widget.
+# Docs: https://wowchemy.com/docs/page-builder/
+widget: tag_cloud
+
+# This file represents a page section.
+headless: true
+
+# Order that this section appears on the page.
+weight: 10
+
+title: Mei's Slide Decks 👩🏼‍🏫
+subtitle: An example of writing _open_ slides with Markdown
+
+content:
+# Choose the taxonomy from `config.yaml` to display (e.g. tags, categories)
+  taxonomy: tags
+  # Choose how many tags you would like to display (0 = all tags)
+  count: 20
+design:
+  # Minimum and maximum font sizes (1.0 = 100%).
+  font_size_min: 1
+  font_size_max: 2.5
+  columns: '1'
+  spacing:
+    padding: ['2rem', 0, '2rem', 0]
+---
+
+Check out my recent decks below or choose a topic to explore ✨

BIN
starters/markdown-slides/content/slides/example/boards.webp


BIN
starters/markdown-slides/content/slides/example/featured.webp


+ 166 - 0
starters/markdown-slides/content/slides/example/index.md

@@ -0,0 +1,166 @@
+---
+title: Example Slides
+summary: An introduction to using Wowchemy's Slides feature.
+authors: []
+tags: ['Tutorials']
+categories: []
+date: '2019-02-05'
+slides:
+  # Choose a theme from https://github.com/hakimel/reveal.js#theming
+  theme: black
+  # Choose a code highlighting style (if highlighting enabled in `params.toml`)
+  #   Light style: github. Dark style: dracula (default).
+  highlight_style: dracula
+---
+
+# Create slides in Markdown with Wowchemy
+
+[Wowchemy](https://wowchemy.com/) | [Documentation](https://wowchemy.com/docs/content/slides/)
+
+---
+
+## Features
+
+- Efficiently write slides in Markdown
+- 3-in-1: Create, Present, and Publish your slides
+- Supports speaker notes
+- Mobile friendly slides
+
+---
+
+## Controls
+
+- Next: `Right Arrow` or `Space`
+- Previous: `Left Arrow`
+- Start: `Home`
+- Finish: `End`
+- Overview: `Esc`
+- Speaker notes: `S`
+- Fullscreen: `F`
+- Zoom: `Alt + Click`
+- [PDF Export](https://github.com/hakimel/reveal.js#pdf-export): `E`
+
+---
+
+## Code Highlighting
+
+Inline code: `variable`
+
+Code block:
+```python
+porridge = "blueberry"
+if porridge == "blueberry":
+    print("Eating...")
+```
+
+---
+
+## Math
+
+In-line math: $x + y = z$
+
+Block math:
+
+$$
+f\left( x \right) = \;\frac{{2\left( {x + 4} \right)\left( {x - 4} \right)}}{{\left( {x + 4} \right)\left( {x + 1} \right)}}
+$$
+
+---
+
+## Fragments
+
+Make content appear incrementally
+
+```
+{{%/* fragment */%}} One {{%/* /fragment */%}}
+{{%/* fragment */%}} **Two** {{%/* /fragment */%}}
+{{%/* fragment */%}} Three {{%/* /fragment */%}}
+```
+
+Press `Space` to play!
+
+{{% fragment %}} _One_ {{% /fragment %}}
+{{% fragment %}} **Two** {{% /fragment %}}
+{{% fragment %}} Three {{% /fragment %}}
+
+---
+
+A fragment can accept two optional parameters:
+
+- `class`: use a custom style (requires definition in custom CSS)
+- `weight`: sets the order in which a fragment appears
+
+---
+
+## Speaker Notes
+
+Add speaker notes to your presentation
+
+```markdown
+{{%/* speaker_note */%}}
+- Only the speaker can read these notes
+- Press `S` key to view
+{{%/* /speaker_note */%}}
+```
+
+Press the `S` key to view the speaker notes!
+
+{{< speaker_note >}}
+- Only the speaker can read these notes
+- Press `S` key to view
+{{< /speaker_note >}}
+
+---
+
+## Themes
+
+- black: Black background, white text, blue links (default)
+- white: White background, black text, blue links
+- league: Gray background, white text, blue links
+- beige: Beige background, dark text, brown links
+- sky: Blue background, thin dark text, blue links
+
+---
+
+- night: Black background, thick white text, orange links
+- serif: Cappuccino background, gray text, brown links
+- simple: White background, black text, blue links
+- solarized: Cream-colored background, dark green text, blue links
+
+---
+
+{{< slide background-image="boards.jpg" >}}
+
+## Custom Slide
+
+Customize the slide style and background
+
+```markdown
+{{</* slide background-image="/media/boards.jpg" */>}}
+{{</* slide background-color="#0000FF" */>}}
+{{</* slide class="my-style" */>}}
+```
+
+---
+
+## Custom CSS Example
+
+Let's make headers navy colored.
+
+Create `assets/css/reveal_custom.css` with:
+
+```css
+.reveal section h1,
+.reveal section h2,
+.reveal section h3 {
+  color: navy;
+}
+```
+
+---
+
+# Questions?
+
+[Ask](https://discord.gg/z8wNYzb)
+
+[Documentation](https://wowchemy.com/docs/content/slides/)

+ 8 - 0
starters/markdown-slides/go.mod

@@ -0,0 +1,8 @@
+module github.com/wowchemy/starter-academic/exampleSite
+
+go 1.15
+
+require (
+	github.com/wowchemy/wowchemy-hugo-modules/wowchemy-cms/v5 v5.0.0-20220109160354-be9e2fde4a4f // indirect
+	github.com/wowchemy/wowchemy-hugo-modules/wowchemy/v5 v5.0.0-20220109160354-be9e2fde4a4f // indirect
+)

+ 4 - 0
starters/markdown-slides/go.sum

@@ -0,0 +1,4 @@
+github.com/wowchemy/wowchemy-hugo-modules/wowchemy-cms/v5 v5.0.0-20220109160354-be9e2fde4a4f h1:swonZoGNetpYa0fzAYQGjLFyNQrnRBaGupyNCxmDQDg=
+github.com/wowchemy/wowchemy-hugo-modules/wowchemy-cms/v5 v5.0.0-20220109160354-be9e2fde4a4f/go.mod h1:Sp/AKo+2HAPi/IPHp1MEdKPmee+mzO5+efUBUPLPqPE=
+github.com/wowchemy/wowchemy-hugo-modules/wowchemy/v5 v5.0.0-20220109160354-be9e2fde4a4f h1:FD0LoG/QlkPypItdrRrpOWkXGQbp2rN/xYLH7Fo+FBo=
+github.com/wowchemy/wowchemy-hugo-modules/wowchemy/v5 v5.0.0-20220109160354-be9e2fde4a4f/go.mod h1:2iL9rdrUYyJXX2BeHKfK+QbqZlubCsaR60nQ87NRQTY=

+ 21 - 0
starters/markdown-slides/netlify.toml

@@ -0,0 +1,21 @@
+[build]
+  command = "hugo --gc --minify -b $URL"
+  publish = "public"
+
+[build.environment]
+  HUGO_VERSION = "0.91.2"
+  HUGO_ENABLEGITINFO = "true"
+
+[context.production.environment]
+  HUGO_ENV = "production"
+
+[context.deploy-preview]
+  command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL"
+
+[context.branch-deploy]
+  command = "hugo --gc --minify -b $DEPLOY_PRIME_URL"
+
+[[plugins]]
+  package = "netlify-plugin-hugo-cache-resources"
+  [plugins.inputs]
+    debug = true