starters: port docs template

Close #3010

starters/documentation/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-900"
+      # 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: ""
+---

starters/documentation/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
+---

starters/documentation/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.

starters/documentation/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

starters/documentation/content/docs/getting-started.md

@@ -0,0 +1,35 @@
+---
+title: Getting Started
+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 >}}

starters/documentation/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 >}}

starters/documentation/content/docs/guide/configuration.md

@@ -0,0 +1,54 @@
+---
+title: Configuration
+weight: 2
+---
+
+The configuration of your site can be found in `config/_default/`.
+
+<!--more-->
+
+## 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
+---
+```

starters/documentation/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/` 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
+---
+```

starters/documentation/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 >}}

starters/documentation/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.
+
+<!--more-->
+
+## 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 */%}}
+```

starters/documentation/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 link="../" title="Learn Shortcodes" icon="academic-cap" >}}
+  {{< card link="" title="A card without an icon or link" >}}
+{{< /cards >}}
+
+is rendered by:
+
+```
+{{</* cards */>}}
+  {{</* card url="../callout" title="Callout" icon="academic-cap" */>}}
+  {{</* card url="" title="A card without an icon" */>}}
+{{</* /cards */>}}
+```
+
+## 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                                                                    |

starters/documentation/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 */%}}
+```

starters/documentation/content/docs/guide/shortcodes/toggle.md

@@ -0,0 +1,27 @@
+---
+title: Spoiler
+---
+
+A Hugo shortcode to toggle collapsible content.
+
+<!--more-->
+
+## Example
+
+{{< spoiler text="Click to view the spoiler" >}}
+You found me!
+
+Markdown is **supported**.
+{{< /spoiler >}}
+
+## Usage
+
+````
+{{</* spoiler text="Click to view the spoiler" */>}}
+
+This is the content of the details.
+
+Markdown is **supported**.
+
+{{</* /spoiler */>}}
+````

starters/documentation/content/docs/reference/_index.md

@@ -0,0 +1,7 @@
+---
+linkTitle: Reference
+title: Reference
+---
+
+This section covers reference docs.
+

starters/documentation/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/

starters/documentation/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.
+
+<!--more-->
+
+View the full docs at https://docs.hugoblox.com/reference/language/

starters/documentation/content/post/_index.md

@@ -0,0 +1,3 @@
+---
+title: Blog
+---

starters/documentation/content/post/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.

starters/documentation/content/post/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.

starters/documentation/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]
+---

starters/documentation/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
+---