diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..574c0a2 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,20 @@ +# editorconfig.org + +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true + +[*.toml] +max_line_length = 100 + +[*.md] +trim_trailing_whitespace = false + +[layouts/shortcodes/*.html] +insert_final_newline = false diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..2ed14d2 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: gcushen +custom: https://hugoblox.com/sponsor/ diff --git a/.github/preview.png b/.github/preview.png new file mode 100644 index 0000000..8fdb18d Binary files /dev/null and b/.github/preview.png differ diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml new file mode 100644 index 0000000..b942bcc --- /dev/null +++ b/.github/workflows/publish.yaml @@ -0,0 +1,72 @@ +name: Deploy website to GitHub Pages + +env: + WC_HUGO_VERSION: '0.123.7' + +on: + # Trigger the workflow every time you push to the `main` branch + push: + branches: ["main"] + # Allows you to run this workflow manually from the Actions tab on GitHub. + workflow_dispatch: + +# Provide permission to clone the repo and deploy it to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build website + build: + if: github.repository_owner != 'HugoBlox' + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + # Fetch history for Hugo's .GitInfo and .Lastmod + fetch-depth: 0 + - name: Setup Hugo + uses: peaceiris/actions-hugo@v2 + with: + hugo-version: ${{ env.WC_HUGO_VERSION }} + extended: true + - uses: actions/cache@v3 + with: + path: /tmp/hugo_cache_runner/ + key: ${{ runner.os }}-hugomod-${{ hashFiles('**/go.mod') }} + restore-keys: | + ${{ runner.os }}-hugomod- + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + - name: Build with Hugo + env: + HUGO_ENVIRONMENT: production + 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: + path: ./public + + # Deploy website to GitHub Pages hosting + deploy: + if: github.repository_owner != 'HugoBlox' + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bda4caf --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +# IDEs +.idea/ + +# Hugo +resources/ +public/ +jsconfig.json diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..05a4f67 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2016-present George Cushen (https://georgecushen.com) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f11c67 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# [Hugo Docs Theme](https://github.com/HugoBlox/theme-documentation) + +[![Screenshot](https://raw.githubusercontent.com/HugoBlox/theme-documentation/main/.github/preview.png)](https://hugoblox.com/templates/details/docs/) + +The Hugo **Documentation Template** empowers with everything you need to build a beautiful documentation website, including a customizable block-based homepage and blog. It's ultra-fast and easy, letting you focus on your content. It's also no-code by default, so no JavaScript knowledge is required unlike other templates! + +️**Trusted by 250,000+ creators, teams, and organizations.** Highly customizable via the integrated **no-code, block-based website builder**, making every site truly personalized ⭐⭐⭐⭐⭐ + +[![Get Started](https://img.shields.io/badge/-Get%20started-ff4655?style=for-the-badge)](https://hugoblox.com/templates/details/docs/) +[![Discord](https://img.shields.io/discord/722225264733716590?style=for-the-badge)](https://discord.com/channels/722225264733716590/742892432458252370/742895548159492138) +[![Twitter Follow](https://img.shields.io/twitter/follow/GetResearchDev?label=Follow%20on%20Twitter)](https://twitter.com/GetResearchDev) + +[Check out the latest demo](https://hugo-docs-theme.netlify.app/) of what you'll get in less than 10 minutes, or [view the showcase](https://hugoblox.com/creators/). + +The integrated [**Hugo Blox**](https://hugoblox.com) website builder and CMS makes it easy to create a beautiful website for free. Edit your site in the CMS (or your favorite editor), generate it with [Hugo](https://github.com/gohugoio/hugo), and deploy with GitHub or Netlify. Customize anything on your site with widgets, light/dark themes, and language packs. + +- 👉 [**Get Started**](https://hugoblox.com/templates/details/docs/) +- 📚 [View the **documentation**](https://docs.hugoblox.com/) +- 💬 [Chat with the **Hugo Blox Builder community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io) +- ⬇️ **Automatically import citations from BibTeX** with the [Academic File Converter](https://github.com/GetRD/academic-file-converter) +- 🐦 Share your new site with the community: [@GetResearchDev](https://twitter.com/GetResearchDev) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithHugoBlox](https://twitter.com/search?q=%23MadeWithHugoBlox&src=typed_query) +- 🗳 [Take the survey and help us improve #OpenSource](https://forms.gle/NioD9VhUg7PNmdCAA) +- 🚀 [Contribute improvements](https://github.com/HugoBlox/hugo-blox-builder/blob/main/CONTRIBUTING.md) or [suggest improvements](https://github.com/HugoBlox/hugo-blox-builder/issues) +- ⬆️ **Updating?** View the [Update Guide](https://docs.hugoblox.com/reference/update/) and [Release Notes](https://github.com/HugoBlox/hugo-blox-builder/releases) + +## We ask you, humbly, to support this open source movement + +Today we ask you to defend the open source independence of the Hugo Blox Builder and themes 🐧 + +We're an open source movement that depends on your support to stay online and thriving, but 99.9% of our creators don't give; they simply look the other way. + +### [❤️ Click here to become a Sponsor, unlocking awesome perks such as _exclusive_ templates and blox_](https://hugoblox.com/sponsor/) diff --git a/assets/media/icon.png b/assets/media/icon.png new file mode 100644 index 0000000..c0c5a39 Binary files /dev/null and b/assets/media/icon.png differ diff --git a/assets/media/icons/custom/.gitkeep b/assets/media/icons/custom/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/assets/media/logo.svg b/assets/media/logo.svg new file mode 100644 index 0000000..4c85673 --- /dev/null +++ b/assets/media/logo.svg @@ -0,0 +1 @@ + diff --git a/config/_default/hugo.yaml b/config/_default/hugo.yaml new file mode 100644 index 0000000..e73aff6 --- /dev/null +++ b/config/_default/hugo.yaml @@ -0,0 +1,98 @@ +# Configuration of Hugo +# Guide: https://docs.hugoblox.com/tutorial/ +# 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: "Hugo Docs" # Website name +baseURL: 'https://example.com/' # Website URL + +############################ +## PAGE OPTIONS +############################ + +cascade: + # Docs folder options + - _target: + path: /docs/** + editable: true + show_breadcrumb: true + # Hide date from Next In Series + show_date: false + # Show date modified at end of content + show_date_updated: true + # Blog post options + - _target: + path: /blog/** + kind: page + pager: true + editable: true + hide_date: false + show_date_updated: true + reading_time: true + commentable: true + show_related: true + share: true + # Just use Breadcrumb for navigation on blog post pages? + show_breadcrumb: false + header: + navbar: + enable: true + +############################ +## LANGUAGE +############################ + +defaultContentLanguage: en +hasCJKLanguage: false +defaultContentLanguageInSubdir: false +removePathAccents: true + +############################ +## ADVANCED +############################ + +build: + writeStats: true +enableGitInfo: false +summaryLength: 30 +paginate: 10 +enableEmoji: true +enableRobotsTXT: true +footnotereturnlinkcontents: ^ +ignoreFiles: [\.ipynb$, .ipynb_checkpoints$, \.Rmd$, \.Rmarkdown$, _cache$] +enableInlineShortcodes: true +permalinks: + authors: '/author/:slug/' + tags: '/tag/:slug/' + categories: '/category/:slug/' +disableAliases: true +outputs: + home: [HTML, RSS, WebAppManifest, headers, redirects] + page: [HTML] + section: [HTML, RSS] +imaging: + resampleFilter: lanczos + quality: 85 + anchor: smart +timeout: 600000 +taxonomies: + tag: tags + category: categories + author: authors +markup: + _merge: deep +related: + threshold: 80 + includeNewer: true + toLower: true + indices: + - name: tags + weight: 100 + - name: categories + weight: 70 +security: + _merge: deep +sitemap: + _merge: deep +minify: + _merge: deep diff --git a/config/_default/languages.yaml b/config/_default/languages.yaml new file mode 100644 index 0000000..88fa733 --- /dev/null +++ b/config/_default/languages.yaml @@ -0,0 +1,22 @@ +# Languages +# Create a section for each of your site's languages. +# Documentation: https://docs.hugoblox.com/reference/language/ + +# Default language +en: + languageCode: en-us + # Uncomment for multi-lingual sites, and move English content into `en` sub-folder. + #contentDir: content/en + +# Uncomment the lines below to configure your website in a second language. +#zh: +# languageCode: zh-Hans +# contentDir: content/zh +# title: Chinese website title... +# params: +# description: Site description in Chinese... +# menu: +# main: +# - name: 传 +# url: '#about' +# weight: 1 diff --git a/config/_default/menus.yaml b/config/_default/menus.yaml new file mode 100644 index 0000000..3d5c6ea --- /dev/null +++ b/config/_default/menus.yaml @@ -0,0 +1,34 @@ +# Navigation Links +# The weight parameter defines the order that the links will appear in. + +main: + - name: Home + url: / + weight: 10 + - name: Documentation + url: docs/ + weight: 20 + - name: Blog + url: blog/ + weight: 30 + - name: Showcase + url: showcase/ + weight: 40 + - name: Community + url: community/ + weight: 50 + +sidebar: + - identifier: more + name: Still need help? + params: + type: separator + weight: 1 + - identifier: community + name: "Community" + pageRef: "/community" + weight: 2 + - identifier: hugoDocs + name: "Hugo Docs ↗" + url: "https://docs.hugoblox.com" + weight: 3 diff --git a/config/_default/module.yaml b/config/_default/module.yaml new file mode 100644 index 0000000..2d7e6af --- /dev/null +++ b/config/_default/module.yaml @@ -0,0 +1,9 @@ +############################ +## HUGO MODULES +## Install or uninstall themes and plugins here. +## Docs: https://gohugo.io/hugo-modules/ +############################ + +imports: + - path: github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify + - path: github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind diff --git a/config/_default/params.yaml b/config/_default/params.yaml new file mode 100644 index 0000000..cb196d7 --- /dev/null +++ b/config/_default/params.yaml @@ -0,0 +1,84 @@ +# SITE SETUP +# Guide: https://docs.hugoblox.com/tutorial/ +# Documentation: https://docs.hugoblox.com/ +# This file is formatted using YAML syntax - learn more at https://learnxinyminutes.com/docs/yaml/ + +# Appearance +appearance: + mode: light + color: blue + +# SEO +marketing: + seo: + site_type: Project + local_business_type: '' + org_name: '' + description: 'A highly-customizable Hugo documentation theme powered by Hugo Blox website builder.' + twitter: 'GetResearchDev' + analytics: + google_analytics: '' + google_tag_manager: '' + microsoft_clarity: '' + baidu_tongji: '' + plausible: '' + fathom: '' + pirsch: '' + verification: + google: '' + baidu: '' + +# Site header +header: + navbar: + enable: true + blox: "navbar" + align: "center" + 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/details/docs/" + show_search: true + show_theme_chooser: true + +# Site footer +footer: + copyright: + notice: '© {year} My Company. This work is licensed under {license}' + license: + enable: true + allow_derivatives: false + share_alike: true + allow_commercial: false + +# Localization +locale: + date_format: 'Jan 2, 2006' + time_format: '3:04 PM' + +# Site features +features: + math: + enable: false + privacy_pack: + enable: false + repository: + url: 'https://github.com/HugoBlox/hugo-blox-builder/' + content_dir: 'starters/documentation/content' + branch: 'main' + feedback: + responses: + positive: 'Glad to hear it! [Any ideas for improvements?](https://github.com///issues/new).' + negative: 'Sorry to hear that. [Please tell us how we can improve](https://github.com///issues/new).' + comment: + provider: '' + giscus: + repo: '' + repo_id: '' + category: '' + category_id: '' diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000..3b98952 --- /dev/null +++ b/content/_index.md @@ -0,0 +1,97 @@ +--- +title: 'Home' +date: 2023-10-24 +type: landing + +design: + # Default section spacing + spacing: "6rem" + +sections: + - block: hero + content: + title: Write Docs Fast, Focus on Your Content + text: The easy, no-code technical documentation solution your users will love 🎉 + primary_action: + text: Get Started + url: https://hugoblox.com/templates/details/docs/ + icon: rocket-launch + secondary_action: + text: Read the docs + url: /docs/ + announcement: + text: "Announcing the release of version 2." + link: + text: "Read more" + url: "/blog/" + design: + spacing: + padding: [0, 0, 0, 0] + margin: [0, 0, 0, 0] + # For full-screen, add `min-h-screen` below + css_class: "" + background: + color: "" + image: + # Add your image background to `assets/media/`. + filename: "" + filters: + brightness: 0.5 + - block: stats + content: + items: + - statistic: "1M+" + description: | + Websites built + with Hugo Blox + - statistic: "10k+" + description: | + GitHub stars + since 2016 + - statistic: "3k+" + description: | + Discord community + for support + design: + # Section background color (CSS class) + css_class: "bg-gray-100 dark:bg-gray-800" + # Reduce spacing + spacing: + padding: ["1rem", 0, "1rem", 0] + - block: features + id: features + content: + title: Features + text: Collaborate, publish, and maintain technical knowledge with an all-in-one documentation site. Used by 100,000+ startups, enterprises, and researchers. + items: + - name: Optimized SEO + icon: magnifying-glass + description: Automatic sitemaps, RSS feeds, and rich metadata take the pain out of SEO and syndication. + - name: Fast + icon: bolt + description: Super fast page load with Tailwind CSS and super fast site building with Hugo. + - name: Easy + icon: sparkles + 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. + - name: Highly Rated + icon: star + description: Rated 5-stars by the community. + - name: Swappable Blocks + icon: rectangle-group + description: Build your pages with blocks - no coding required! + - block: cta-card + content: + title: "Start Writing with the #1 Effortless Documentation Platform" + text: Hugo Blox Docs Theme brings all your technical knowledge together in a single, centralized knowledge base. Easily search and edit it with the tools you use every day! + button: + text: Get Started + url: https://hugoblox.com/templates/details/docs/ + design: + card: + # Card background color (CSS class) + css_class: "bg-primary-700" + css_style: "" +--- diff --git a/content/authors/_index.md b/content/authors/_index.md new file mode 100644 index 0000000..c5e4b7b --- /dev/null +++ b/content/authors/_index.md @@ -0,0 +1,9 @@ +--- +# To publish author profile pages, remove all the `_build` and `cascade` settings below. +_build: + render: never +cascade: + _build: + render: never + list: always +--- diff --git a/content/authors/admin/_index.md b/content/authors/admin/_index.md new file mode 100644 index 0000000..ebc5fef --- /dev/null +++ b/content/authors/admin/_index.md @@ -0,0 +1,59 @@ +--- +# Display name +title: 吳健雄 + +# Name pronunciation (optional) +name_pronunciation: Chien Shiung Wu + +# Full name (for SEO) +first_name: Shiung Wu +last_name: Chien + +# Status emoji +status: + icon: ☕️ + +# Is this the primary user of the site? +superuser: true + +# Role/position/tagline +role: Professor of Artificial Intelligence + +# Organizations/Affiliations to show in About widget +organizations: + - name: Stanford University + url: https://www.stanford.edu/ + +# Short bio (displayed in user profile at end of posts) +bio: My research interests include distributed robotics, mobile computing and programmable matter. + +# Social Networking +# Need to use another icon? Simply download the SVG icon to your `assets/media/icons/` folder. +profiles: + - icon: at-symbol + url: 'mailto:your-email@example.com' + label: E-mail Me + - icon: brands/x + url: https://twitter.com/GetResearchDev + - icon: brands/instagram + url: https://www.instagram.com/ + - icon: brands/linkedin + url: https://www.linkedin.com/ + # Link to a PDF of your resume/CV - upload it to `static/uploads/resume.pdf` + - icon: academicons/cv + url: uploads/resume.pdf + label: Download my resume + - icon: rss + url: ./post/index.xml + label: Subscribe to my blog via RSS feed + +# Highlight the author in author lists? (true/false) +highlight_name: true + +# Author's website URL +website: "" +--- + +Chien Shiung Wu is a professor of artificial intelligence at the Stanford AI Lab. Her research interests include +distributed robotics, mobile computing and programmable matter. She leads the Robotic Neurobiology group, which develops +self-reconfiguring robots, systems of self-organizing robots, and mobile sensor networks. diff --git a/content/authors/admin/avatar.jpg b/content/authors/admin/avatar.jpg new file mode 100644 index 0000000..49337e4 Binary files /dev/null and b/content/authors/admin/avatar.jpg differ diff --git a/content/blog/_index.md b/content/blog/_index.md new file mode 100644 index 0000000..f040c7e --- /dev/null +++ b/content/blog/_index.md @@ -0,0 +1,5 @@ +--- +title: Blog +view: date-title-summary +url: /blog/ +--- diff --git a/content/blog/v1.0.0/featured.jpg b/content/blog/v1.0.0/featured.jpg new file mode 100644 index 0000000..8c97312 Binary files /dev/null and b/content/blog/v1.0.0/featured.jpg differ diff --git a/content/blog/v1.0.0/index.md b/content/blog/v1.0.0/index.md new file mode 100644 index 0000000..694f26e --- /dev/null +++ b/content/blog/v1.0.0/index.md @@ -0,0 +1,41 @@ +--- +title: v1.0.0 Released! +summary: Hugo v1.0.0 released. Download now and follow the guide to get started in 5 minutes! +date: 2023-01-01 +authors: + - admin +tags: + - Hugo + - Hugo Blox + - Markdown +image: + caption: 'Image credit: [**Unsplash**](https://unsplash.com)' +--- + +Hugo v1.0.0 is now available! This release includes new experimental features to try out, improvements to accessibility, the ability for plugins to customize image optimization in Markdown, and many more improvements and bug fixes. + +Highlights include: + +- New config options +- Improved accessibility +- Customizable image optimization in Markdown + +Thank you to everyone who contributed to this release! + +## New Features + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. + +## Bug Fixes + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. + +## How to Upgrade + +Simply run the following command in your terminal: + +```bash +hugo mod get -u github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind@main +``` + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. diff --git a/content/blog/v2.0.0/featured.jpg b/content/blog/v2.0.0/featured.jpg new file mode 100644 index 0000000..8c97312 Binary files /dev/null and b/content/blog/v2.0.0/featured.jpg differ diff --git a/content/blog/v2.0.0/index.md b/content/blog/v2.0.0/index.md new file mode 100644 index 0000000..1c2d1a6 --- /dev/null +++ b/content/blog/v2.0.0/index.md @@ -0,0 +1,41 @@ +--- +title: v2.0.0 Released! +summary: Hugo v2.0.0 released. Download now and follow the guide to get started in 5 minutes! +date: 2024-01-19 +authors: + - admin +tags: + - Hugo + - Hugo Blox + - Markdown +image: + caption: 'Image credit: [**Unsplash**](https://unsplash.com)' +--- + +Hugo v2.0.0 is now available! This release includes new experimental features to try out, improvements to accessibility, the ability for plugins to customize image optimization in Markdown, and many more improvements and bug fixes. + +Highlights include: + +- New config options +- Improved accessibility +- Customizable image optimization in Markdown + +Thank you to everyone who contributed to this release! + +## New Features + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. + +## Bug Fixes + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. + +## How to Upgrade + +Simply run the following command in your terminal: + +```bash +hugo mod get -u github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind@main +``` + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae fringilla sem. Integer mattis dictum augue non auctor. Proin quis porttitor enim. Praesent vulputate arcu egestas scelerisque condimentum. Vivamus elit risus, suscipit et enim et, viverra molestie elit. Nulla ullamcorper nisl vel nisi pellentesque, id feugiat risus interdum. Duis consequat ipsum elit. Aenean hendrerit diam ipsum, a convallis magna congue et. Sed ex erat, pretium et ante id, malesuada luctus nibh. Nunc nec consectetur elit. diff --git a/content/community/index.md b/content/community/index.md new file mode 100644 index 0000000..2fd5d6d --- /dev/null +++ b/content/community/index.md @@ -0,0 +1,36 @@ +--- +title: Community +toc: true +reading_time: false +pager: false +--- + +## Support + +Get support fast. Hugo Blox has the largest Hugo community on Discord, consisting of thousands of creators, developers, and startups. + +## Docs + +- View the [Hugo Blox Documentation](https://docs.hugoblox.com/) + +## Live Chat {#chat} + +- Join the [Hugo Blox Online Chat](https://discord.gg/z8wNYzb) + - _#using-hugo-blox_ for user help + - _#contributors_ for contributing help + +## Feature requests {#feature-requests} + +For new feature requests, create a post on our [GitHub Issues](https://github.com/HugoBlox/hugo-blox-builder/issues). You can also upvote existing feature requests with a 👍 + +## News {#news} + +Follow us so you are the first to know when new features and templates are launched: + +- [Subscribe to the _#announcement_ channel on Discord](https://discord.gg/z8wNYzb) +- [Follow us on Twitter](https://twitter.com/GetResearchDev) +- [Subscribe to the Hugo Blox blog](https://hugoblox.com/blog/) + +## Further Resources + +- [Hugo Forums](https://discourse.gohugo.io/) for help installing Hugo and resolving Hugo error messages diff --git a/content/docs/_index.md b/content/docs/_index.md new file mode 100644 index 0000000..ea98d22 --- /dev/null +++ b/content/docs/_index.md @@ -0,0 +1,16 @@ +--- +linkTitle: Documentation +title: Introduction +--- + +👋 Welcome to the demo of the Hugo Blox Documentation template! + + + +This site is a demo of the Hugo Blox Documentation theme. For the full documentation on how to use this template, refer to the [Hugo Blox Documentation](https://docs.hugoblox.com/). + +## Next + +{{< cards >}} + {{< card url="getting-started" title="Get Started" icon="document-text" subtitle="Create your docs in just 5 minutes!" >}} +{{< /cards >}} diff --git a/content/docs/getting-started.md b/content/docs/getting-started.md new file mode 100644 index 0000000..f504fda --- /dev/null +++ b/content/docs/getting-started.md @@ -0,0 +1,36 @@ +--- +title: Getting Started +date: 2024-02-17 +weight: 1 +--- + +## Quick Start from Template + +{{% steps %}} + +### Initialize a new site + +[Click to copy the template on GitHub](https://github.com/new?template_name=theme-documentation&template_owner=HugoBlox) + +### Configure your new site + +[Configure your site name, description, and menu.](https://docs.hugoblox.com/tutorial/blog/) + +### Add your content + +[Edit the homepage and add your documentation pages.](https://docs.hugoblox.com/tutorial/blog/) + +### Publish your site + +[Easily publish your site for free with GitHub Pages](https://docs.hugoblox.com/tutorial/blog/) + +{{% /steps %}} + +## Next + +Let's customize your new site: + +{{< cards >}} + {{< card url="../guide/project-structure" title="Project Structure" icon="document-duplicate" >}} + {{< card url="../guide/configuration" title="Configuration" icon="adjustments-vertical" >}} +{{< /cards >}} diff --git a/content/docs/guide/_index.md b/content/docs/guide/_index.md new file mode 100644 index 0000000..2547070 --- /dev/null +++ b/content/docs/guide/_index.md @@ -0,0 +1,11 @@ +--- +title: Guide +weight: 2 +sidebar: + open: true +--- + +{{< cards >}} + {{< card url="project-structure" title="Project Structure" icon="document-duplicate" >}} + {{< card url="configuration" title="Configuration" icon="adjustments-vertical" >}} +{{< /cards >}} diff --git a/content/docs/guide/configuration.md b/content/docs/guide/configuration.md new file mode 100644 index 0000000..d66e59c --- /dev/null +++ b/content/docs/guide/configuration.md @@ -0,0 +1,54 @@ +--- +title: Configuration +weight: 2 +--- + +The configuration of your site can be found in `config/_default/`. + + + +## Full Documentation + +See https://docs.hugoblox.com/getting-started/customize/ + +## Navigation + +### Menu + +See https://docs.hugoblox.com/getting-started/customize/#menu-items + +## Left Sidebar + +Links are automatically generated from the structure of your content directory. Simply add a folder to nest a page. + +### Extra Links + +Additional links can be added under the `sidebar` section of your `config/_default/menus.yaml`: + +```yaml +menu: + sidebar: + - name: "Need help?" + params: + type: separator + weight: 1 + - name: "A page" + pageRef: "/page-filename-here" + weight: 2 + - name: "An external link ↗" + url: "https://hugoblox.com" + weight: 3 +``` + +## Right Sidebar + +A table of contents is automatically generated from the headings your Markdown file. + +It can optionally be disabled by setting `toc: false` in the front matter of a page: + +```yaml +--- +title: My Page +toc: false +--- +``` diff --git a/content/docs/guide/project-structure.md b/content/docs/guide/project-structure.md new file mode 100644 index 0000000..b3a6bf0 --- /dev/null +++ b/content/docs/guide/project-structure.md @@ -0,0 +1,59 @@ +--- +title: Project Structure +weight: 1 +--- + +## Folder Structure + +There are **4 main folders for Hugo-based sites**: + +- `content/` for your Markdown-formatted content files (homepage, etc.) + - `_index.md` the homepage (**Hugo requires that the homepage and archive pages have an underscore prefix**) +- `assets/` + - `media/` for your media files (images, videos) + - `icons/custom/` upload any custom SVG icons you want to use +- `config/_default/` for your site configuration files + - `hugo.yaml` to configure Hugo (site title, URL, Hugo options, setup per-folder page features) + - `module.yaml` to install or uninstall Hugo themes and plugins + - `params.yaml` to configure Hugo Blox options (SEO, analytics, site features) + - `menus.yaml` to configure your menu links (if the menu is enabled in `params.yaml`) + - `languages.yaml` to configure your site's language or to set language-specific options in a multilingual site +- `static/uploads/` for any files you want visitors to download, such as a PDF +- `go.mod` sets the version of Hugo themes/plugins which your site uses + + +## Hugo File Naming Convention + +Hugo gives us two options to name standard page files: as `TITLE/index.md` or `TITLE.md` where `TITLE` is your page name. + +The page name should be lowercase and using hyphens (`-`) instead of spaces. + +Both approaches result in the same output, so you can choose your preferred approach to naming and organizing files. A benefit to the folder-based approach is that all your page's files (such as images) are self-contained within the page's folder, so it's more portable if you wish to share the original Markdown page with someone. + +The homepage is a special case as **Hugo requires the homepage and listing pages to be named** `_index.md`. + +## Docs Navigation + +The docs navigation is automatically generated based on the content in the `docs/` folder and is sorted alphabetically. + +The order of pages can be changed by adding the `weight` parameter in the front matter of your Markdown files. + +In the example below, the `example.md` page will appear before the `test.md` page as it has a lower `weight`: + +Page `example.md`: + +```yaml +--- +title: My Example +weight: 1 +--- +``` + +Page `test.md`: + +```yaml +--- +title: My Test +weight: 2 +--- +``` diff --git a/content/docs/guide/shortcodes/_index.md b/content/docs/guide/shortcodes/_index.md new file mode 100644 index 0000000..878ee4b --- /dev/null +++ b/content/docs/guide/shortcodes/_index.md @@ -0,0 +1,12 @@ +--- +title: Shortcodes +--- + +Build the best docs with re-usable components, referred to as Hugo shortcodes: + +{{< cards >}} + {{< card url="callout" title="Callout" icon="warning" >}} + {{< card url="cards" title="Cards" icon="card" >}} + {{< card url="toggle" title="Spoiler" icon="chevron-right" >}} + {{< card url="steps" title="Steps" icon="one" >}} +{{< /cards >}} diff --git a/content/docs/guide/shortcodes/callout.md b/content/docs/guide/shortcodes/callout.md new file mode 100644 index 0000000..7ce7a93 --- /dev/null +++ b/content/docs/guide/shortcodes/callout.md @@ -0,0 +1,36 @@ +--- +title: Callout Shortcode +linkTitle: Callout +--- + +Hugo Blox supports a Markdown extension for callouts, also referred to as alerts or asides. + +Callouts are a useful feature to draw attention to important or related content such as notes, hints, or warnings in your articles. + + + +## Usage + +### Notes + +{{% callout note %}} +A Markdown callout is useful for displaying notices, hints, or definitions to your readers. +{{% /callout %}} + +```markdown +{{%/* callout note */%}} +A Markdown callout is useful for displaying notices, hints, or definitions to your readers. +{{%/* /callout */%}} +``` + +### Warnings + +{{% callout warning %}} +Here's some important information... +{{% /callout %}} + +```markdown +{{%/* callout warning */%}} +Here's some important information... +{{%/* /callout */%}} +``` diff --git a/content/docs/guide/shortcodes/cards.md b/content/docs/guide/shortcodes/cards.md new file mode 100644 index 0000000..96ecd95 --- /dev/null +++ b/content/docs/guide/shortcodes/cards.md @@ -0,0 +1,31 @@ +--- +title: Cards Shortcode +linkTitle: Cards +--- + +A Hugo extension to create cards. Cards can be shown as links or as plain text. + +## Usage + +{{< cards >}} + {{< card url="../" title="Learn Shortcodes" icon="academic-cap" >}} + {{< card url="" title="A card without an icon or link" >}} +{{< /cards >}} + +is rendered by: + +``` +{{}} + {{}} + {{}} +{{}} +``` + +## Options + +| Parameter | Description | +|------------|------------------------------------------------------------------------| +| `icon` | Name of the icon. Defaults to [Hero Icon Pack](https://heroicons.com/) | +| `title` | Title heading for the card. | +| `subtitle` | Subtitle heading (supports Markdown). | +| `url` | URL | diff --git a/content/docs/guide/shortcodes/steps.md b/content/docs/guide/shortcodes/steps.md new file mode 100644 index 0000000..254981c --- /dev/null +++ b/content/docs/guide/shortcodes/steps.md @@ -0,0 +1,47 @@ +--- +title: Steps Shortcode +linkTitle: Steps +--- + +Display a series of steps, such as for a tutorial. + +## Example + +{{% steps %}} + +### Step 1 + +The first step here... + +### Step 2 + +The second step here... + +### Step 3 + +The third step here... + +{{% /steps %}} + + +## Usage + +Use the Markdown level-3 headings to represent step titles within the `steps` shortcode: + +``` +{{%/* steps */%}} + +### Step 1 + +The first step here... + +### Step 2 + +The second step here... + +### Step 3 + +The third step here... + +{{%/* /steps */%}} +``` diff --git a/content/docs/guide/shortcodes/toggle.md b/content/docs/guide/shortcodes/toggle.md new file mode 100644 index 0000000..a459a9f --- /dev/null +++ b/content/docs/guide/shortcodes/toggle.md @@ -0,0 +1,27 @@ +--- +title: Spoiler +--- + +A Hugo shortcode to toggle collapsible content. + + + +## Example + +{{< spoiler text="Click to view the spoiler" >}} +You found me! + +Markdown is **supported**. +{{< /spoiler >}} + +## Usage + +```` +{{}} + +This is the content of the details. + +Markdown is **supported**. + +{{}} +```` diff --git a/content/docs/reference/_index.md b/content/docs/reference/_index.md new file mode 100644 index 0000000..74cc26c --- /dev/null +++ b/content/docs/reference/_index.md @@ -0,0 +1,7 @@ +--- +linkTitle: Reference +title: Reference +--- + +This section covers reference docs. + diff --git a/content/docs/reference/customization.md b/content/docs/reference/customization.md new file mode 100644 index 0000000..8c197f2 --- /dev/null +++ b/content/docs/reference/customization.md @@ -0,0 +1,7 @@ +--- +title: Customizing Hugo +linkTitle: Customization +weight: 1 +--- + +View the full docs at https://docs.hugoblox.com/getting-started/customize/ diff --git a/content/docs/reference/i18n.md b/content/docs/reference/i18n.md new file mode 100644 index 0000000..61327a6 --- /dev/null +++ b/content/docs/reference/i18n.md @@ -0,0 +1,9 @@ +--- +title: Internationalization (i18n) +--- + +Hugo Blox enables you to easily edit the interface text as well as translating your site into multiple languages using Hugo's [multilingual](https://gohugo.io/content-management/multilingual/) feature. + + + +View the full docs at https://docs.hugoblox.com/reference/language/ diff --git a/content/showcase/_index.md b/content/showcase/_index.md new file mode 100644 index 0000000..dc1a31c --- /dev/null +++ b/content/showcase/_index.md @@ -0,0 +1,34 @@ +--- +title: Showcase +description: "Docs websites powered by Hugo Blox." +type: landing + + + +sections: + - block: hero + content: + title: Get Inspirated + text: 'Get inspired by exploring sites #MadeWithHugoBlox' + primary_action: + icon: brands/x + text: Submit Your Site + url: "https://twitter.com/intent/tweet?text=I%27m%20creating%20a%20beautiful%20website%20using%20the%20free%20%E2%9D%A4%EF%B8%8F%2C%20open%20source%20Hugo%20Blox%20Website%20Builder%20for%20%40GoHugoIO%20by%20%40GeorgeCushen%20%40GetResearchDev%20%E2%9C%A8%20Have%20some%20feedback%3F%20Please%20comment%20%F0%9F%A4%97&hashtags=MadeWithHugoBlox&url=https://HugoBlox.com/" + secondary_action: + text: Explore More on HugoBlox.com + url: https://hugoblox.com/creators/ + design: + no_padding: true + spacing: + padding: [0, 0, 0, 0] + margin: [0, 0, 0, 0] + - block: collection + content: + filters: + folders: + - showcase + design: + view: card + spacing: + padding: ['3rem', 0, '6rem', 0] +--- diff --git a/content/showcase/nvidia/featured.webp b/content/showcase/nvidia/featured.webp new file mode 100644 index 0000000..e257daa Binary files /dev/null and b/content/showcase/nvidia/featured.webp differ diff --git a/content/showcase/nvidia/index.md b/content/showcase/nvidia/index.md new file mode 100644 index 0000000..bfa17a2 --- /dev/null +++ b/content/showcase/nvidia/index.md @@ -0,0 +1,6 @@ +--- +title: Nvidia +summary: nvidia.com +external_link: https://research.nvidia.com/labs/toronto-ai/ +date: 2024-02-17 +--- diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..536f069 --- /dev/null +++ b/go.mod @@ -0,0 +1,8 @@ +module github.com/HugoBlox/theme-documentation + +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.20240303165809-469a458ab94f +) diff --git a/hugoblox.yaml b/hugoblox.yaml new file mode 100644 index 0000000..976a936 --- /dev/null +++ b/hugoblox.yaml @@ -0,0 +1,2 @@ +build: + hugo_version: '0.123.7' diff --git a/images/screenshot.png b/images/screenshot.png new file mode 100644 index 0000000..739f8bf Binary files /dev/null and b/images/screenshot.png differ diff --git a/images/tn.png b/images/tn.png new file mode 100644 index 0000000..48d6b3c Binary files /dev/null and b/images/tn.png differ diff --git a/netlify.toml b/netlify.toml new file mode 100644 index 0000000..be5d5f2 --- /dev/null +++ b/netlify.toml @@ -0,0 +1,21 @@ +[build] + command = "hugo --gc --minify -b $URL && npx pagefind --source 'public'" + publish = "public" + +[build.environment] + HUGO_VERSION = "0.123.7" + 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 diff --git a/static/uploads/.gitkeep b/static/uploads/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/theme.toml b/theme.toml new file mode 100644 index 0000000..83e797a --- /dev/null +++ b/theme.toml @@ -0,0 +1,15 @@ +name = "Easy Docs" +license = "MIT" +licenselink = "https://github.com/HugoBlox/theme-documentation/blob/main/LICENSE.md" +description = "Easy, all-in-one beautiful documentation website including a customizable homepage and blog. Super fast, empowering you to focus on your content." + +homepage = "https://github.com/HugoBlox/theme-documentation" +demosite = "https://hugo-docs-theme.netlify.app" + +tags = ["landing", "docs", "blog", "responsive", "minimal", "light", "dark", "multilingual", "dark mode", "tailwind", "company", "gallery"] +features = ["secure", "fast", "search", "dark mode", "widgets"] + +# If the theme has a single author +[author] + name = "George Cushen" + homepage = "https://georgecushen.com/"