From 66d2bf57ba71c5e79b20e23e1e76687a5dfbdf91 Mon Sep 17 00:00:00 2001 From: Xin Date: Sun, 18 Aug 2024 16:34:48 +0100 Subject: [PATCH] docs: additional shortcodes (#441) * Create pdf.md * Update pdf.md * Escape PDF shortcode examples * Remove markdown syntax highlight * chore: update Hugo and Go versions for deployment * docs: add additional shortcodes * chore: re-compile --------- Co-authored-by: Shahar Naveh <50263213+ShaharNaveh@users.noreply.github.com> --- assets/css/compiled/main.css | 2 +- exampleSite/content/docs/guide/deploy-site.md | 6 +-- .../content/docs/guide/shortcodes/_index.md | 9 +++- .../content/docs/guide/shortcodes/others.md | 43 +++++++++++++++++++ exampleSite/hugo_stats.json | 2 + package-lock.json | 24 +++++------ 6 files changed, 69 insertions(+), 17 deletions(-) create mode 100644 exampleSite/content/docs/guide/shortcodes/others.md diff --git a/assets/css/compiled/main.css b/assets/css/compiled/main.css index 6a48fc08..1a63ece0 100644 --- a/assets/css/compiled/main.css +++ b/assets/css/compiled/main.css @@ -1,5 +1,5 @@ /* -! tailwindcss v3.4.9 | MIT License | https://tailwindcss.com +! tailwindcss v3.4.10 | MIT License | https://tailwindcss.com *//* 1. Prevent padding and border from affecting element width. (https://github.com/mozdevs/cssremedy/issues/4) 2. Allow adding a border to an element by just adding a border-width. (https://github.com/tailwindcss/tailwindcss/pull/116) diff --git a/exampleSite/content/docs/guide/deploy-site.md b/exampleSite/content/docs/guide/deploy-site.md index 79d20790..57103f65 100644 --- a/exampleSite/content/docs/guide/deploy-site.md +++ b/exampleSite/content/docs/guide/deploy-site.md @@ -54,7 +54,7 @@ jobs: build: runs-on: ubuntu-latest env: - HUGO_VERSION: 0.121.2 + HUGO_VERSION: 0.131.0 steps: - name: Checkout uses: actions/checkout@v4 @@ -64,7 +64,7 @@ jobs: - name: Setup Go uses: actions/setup-go@v5 with: - go-version: '1.21' + go-version: '1.22' - name: Setup Pages id: pages uses: actions/configure-pages@v4 @@ -146,7 +146,7 @@ For more details, check out: 3. If you are not using [hextra-starter-template][hextra-starter-template], configure the following manually: - Configure the Build command to `hugo --gc --minify` - Specify the Publish directory to `public` - - Add Environment variable `HUGO_VERSION` and set to `0.119.0` + - Add Environment variable `HUGO_VERSION` and set to `0.132.2` 4. Deploy! Check [Hugo on Netlify](https://docs.netlify.com/integrations/frameworks/hugo/) for more details. diff --git a/exampleSite/content/docs/guide/shortcodes/_index.md b/exampleSite/content/docs/guide/shortcodes/_index.md index bc909f1a..1ecaab97 100644 --- a/exampleSite/content/docs/guide/shortcodes/_index.md +++ b/exampleSite/content/docs/guide/shortcodes/_index.md @@ -9,7 +9,6 @@ next: /docs/guide/shortcodes/callout Hextra provides a collection of beautiful shortcodes to enhance your content. - {{< cards >}} {{< card link="callout" title="Callout" icon="warning" >}} {{< card link="cards" title="Cards" icon="card" >}} @@ -19,3 +18,11 @@ Hextra provides a collection of beautiful shortcodes to enhance your content. {{< card link="steps" title="Steps" icon="one" >}} {{< card link="tabs" title="Tabs" icon="collection" >}} {{< /cards >}} + +
+ +Additional shortcodes provided by Hugo and Hextra: + +{{< cards >}} + {{< card link="others" title="Others" icon="view-grid" >}} +{{< /cards >}} diff --git a/exampleSite/content/docs/guide/shortcodes/others.md b/exampleSite/content/docs/guide/shortcodes/others.md new file mode 100644 index 00000000..19bb0dfe --- /dev/null +++ b/exampleSite/content/docs/guide/shortcodes/others.md @@ -0,0 +1,43 @@ +--- +title: Other Shortcodes +linkTitle: Others +sidebar: + exclude: true +--- + +{{< callout emoji="ℹ️" >}} + Some of these are Hugo built-in shortcodes. + These shortcodes are considered less stable and may be changed anytime. +{{< /callout >}} + +## YouTube + +Embed a YouTube video. + +``` +{{}} +``` + +Result: + +{{< youtube id=dQw4w9WgXcQ loading=lazy >}} + +For more information, see [Hugo's YouTube Shortcode](https://gohugo.io/content-management/shortcodes/#youtube). + +## PDF + +With PDF shortcode, you can embed a PDF file in your content. + +``` +{{}} +``` + +You can also place the PDF file in your project directory and use the relative path. + +``` +{{}} +``` + +Example: + +{{< pdf "https://upload.wikimedia.org/wikipedia/commons/1/13/Example.pdf" >}} diff --git a/exampleSite/hugo_stats.json b/exampleSite/hugo_stats.json index 48b5db2a..2003dd80 100644 --- a/exampleSite/hugo_stats.json +++ b/exampleSite/hugo_stats.json @@ -27,6 +27,7 @@ "head", "hr", "html", + "iframe", "img", "input", "kbd", @@ -221,6 +222,7 @@ "hextra-filetree", "hextra-filetree-folder", "hextra-footer", + "hextra-pdf", "hextra-scrollbar", "hextra-sidebar-collapsible-button", "hextra-tabs-panel", diff --git a/package-lock.json b/package-lock.json index a461df4e..8419af23 100644 --- a/package-lock.json +++ b/package-lock.json @@ -582,9 +582,9 @@ "license": "MIT" }, "node_modules/electron-to-chromium": { - "version": "1.5.6", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.6.tgz", - "integrity": "sha512-jwXWsM5RPf6j9dPYzaorcBSUg6AiqocPEyMpkchkvntaH9HGfOOMZwxMJjDY/XEs3T5dM7uyH1VhRMkqUU9qVw==", + "version": "1.5.11", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.11.tgz", + "integrity": "sha512-R1CccCDYqndR25CaXFd6hp/u9RaaMcftMkphmvuepXr5b1vfLkRml6aWVeBhXJ7rbevHkKEMJtz8XqPf7ffmew==", "dev": true, "license": "ISC" }, @@ -815,9 +815,9 @@ } }, "node_modules/ignore": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", - "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", + "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", "dev": true, "license": "MIT", "engines": { @@ -1376,9 +1376,9 @@ } }, "node_modules/postcss-selector-parser": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.1.1.tgz", - "integrity": "sha512-b4dlw/9V8A71rLIDsSwVmak9z2DuBUB7CA1/wSdelNEzqsjoSPeADTWNO09lpH49Diy3/JIZ2bSPB1dI3LJCHg==", + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.1.2.tgz", + "integrity": "sha512-Q8qQfPiZ+THO/3ZrOrO0cJJKfpYCagtMUkXbnEfmgUjwXg6z/WBeOyS9APBBPCTSiDV+s4SwQGu8yFsiMRIudg==", "dev": true, "license": "MIT", "dependencies": { @@ -1745,9 +1745,9 @@ } }, "node_modules/tailwindcss": { - "version": "3.4.9", - "resolved": "https://registry.npmjs.org/tailwindcss/-/tailwindcss-3.4.9.tgz", - "integrity": "sha512-1SEOvRr6sSdV5IDf9iC+NU4dhwdqzF4zKKq3sAbasUWHEM6lsMhX+eNN5gkPx1BvLFEnZQEUFbXnGj8Qlp83Pg==", + "version": "3.4.10", + "resolved": "https://registry.npmjs.org/tailwindcss/-/tailwindcss-3.4.10.tgz", + "integrity": "sha512-KWZkVPm7yJRhdu4SRSl9d4AK2wM3a50UsvgHZO7xY77NQr2V+fIrEuoDGQcbvswWvFGbS2f6e+jC/6WJm1Dl0w==", "dev": true, "license": "MIT", "dependencies": {