Skip to content

Commit

Permalink
starters: port docs template
Browse files Browse the repository at this point in the history
  • Loading branch information
Splitter committed Feb 17, 2024
1 parent dbf6ac4 commit fdaf50c
Show file tree
Hide file tree
Showing 27 changed files with 662 additions and 0 deletions.
Binary file added .github/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/media/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
97 changes: 97 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -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: ""
---
9 changes: 9 additions & 0 deletions content/authors/_index.md
Original file line number Diff line number Diff line change
@@ -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
---
59 changes: 59 additions & 0 deletions content/authors/admin/_index.md
Original file line number Diff line number Diff line change
@@ -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:[email protected]'
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.
Binary file added content/authors/admin/avatar.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions content/community/index.md
Original file line number Diff line number Diff line change
@@ -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
35 changes: 35 additions & 0 deletions content/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -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 >}}
11 changes: 11 additions & 0 deletions content/docs/guide/_index.md
Original file line number Diff line number Diff line change
@@ -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 >}}
54 changes: 54 additions & 0 deletions content/docs/guide/configuration.md
Original file line number Diff line number Diff line change
@@ -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
---
```
59 changes: 59 additions & 0 deletions content/docs/guide/project-structure.md
Original file line number Diff line number Diff line change
@@ -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
---
```
12 changes: 12 additions & 0 deletions content/docs/guide/shortcodes/_index.md
Original file line number Diff line number Diff line change
@@ -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 >}}
Loading

0 comments on commit fdaf50c

Please sign in to comment.