Skip to content

Commit fdaf50c

Browse files
author
Splitter
committed
starters: port docs template
1 parent dbf6ac4 commit fdaf50c

27 files changed

+662
-0
lines changed

‎.github/preview.png

62.6 KB
Loading

‎assets/media/logo.svg

+1
Loading

‎content/_index.md

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: 'Home'
3+
date: 2023-10-24
4+
type: landing
5+
6+
design:
7+
# Default section spacing
8+
spacing: "6rem"
9+
10+
sections:
11+
- block: hero
12+
content:
13+
title: Write Docs Fast, Focus on Your Content
14+
text: The easy, no-code technical documentation solution your users will love 🎉
15+
primary_action:
16+
text: Get Started
17+
url: https://hugoblox.com/templates/details/docs/
18+
icon: rocket-launch
19+
secondary_action:
20+
text: Read the docs
21+
url: /docs/
22+
announcement:
23+
text: "Announcing the release of version 2."
24+
link:
25+
text: "Read more"
26+
url: "/blog/"
27+
design:
28+
spacing:
29+
padding: [0, 0, 0, 0]
30+
margin: [0, 0, 0, 0]
31+
# For full-screen, add `min-h-screen` below
32+
css_class: ""
33+
background:
34+
color: ""
35+
image:
36+
# Add your image background to `assets/media/`.
37+
filename: ""
38+
filters:
39+
brightness: 0.5
40+
- block: stats
41+
content:
42+
items:
43+
- statistic: "1M+"
44+
description: |
45+
Websites built
46+
with Hugo Blox
47+
- statistic: "10k+"
48+
description: |
49+
GitHub stars
50+
since 2016
51+
- statistic: "3k+"
52+
description: |
53+
Discord community
54+
for support
55+
design:
56+
# Section background color (CSS class)
57+
css_class: "bg-gray-100 dark:bg-gray-900"
58+
# Reduce spacing
59+
spacing:
60+
padding: ["1rem", 0, "1rem", 0]
61+
- block: features
62+
id: features
63+
content:
64+
title: Features
65+
text: Collaborate, publish, and maintain technical knowledge with an all-in-one documentation site. Used by 100,000+ startups, enterprises, and researchers.
66+
items:
67+
- name: Optimized SEO
68+
icon: magnifying-glass
69+
description: Automatic sitemaps, RSS feeds, and rich metadata take the pain out of SEO and syndication.
70+
- name: Fast
71+
icon: bolt
72+
description: Super fast page load with Tailwind CSS and super fast site building with Hugo.
73+
- name: Easy
74+
icon: sparkles
75+
description: One-click deployment to GitHub Pages. Have your new website live within 5 minutes!
76+
- name: No-Code
77+
icon: code-bracket
78+
description: Edit and design your site just using rich text (Markdown) and configurable YAML parameters.
79+
- name: Highly Rated
80+
icon: star
81+
description: Rated 5-stars by the community.
82+
- name: Swappable Blocks
83+
icon: rectangle-group
84+
description: Build your pages with blocks - no coding required!
85+
- block: cta-card
86+
content:
87+
title: "Start Writing with the #1 Effortless Documentation Platform"
88+
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!
89+
button:
90+
text: Get Started
91+
url: https://hugoblox.com/templates/details/docs/
92+
design:
93+
card:
94+
# Card background color (CSS class)
95+
css_class: "bg-primary-700"
96+
css_style: ""
97+
---

‎content/authors/_index.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
# To publish author profile pages, remove all the `_build` and `cascade` settings below.
3+
_build:
4+
render: never
5+
cascade:
6+
_build:
7+
render: never
8+
list: always
9+
---

‎content/authors/admin/_index.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
# Display name
3+
title: 吳健雄
4+
5+
# Name pronunciation (optional)
6+
name_pronunciation: Chien Shiung Wu
7+
8+
# Full name (for SEO)
9+
first_name: Shiung Wu
10+
last_name: Chien
11+
12+
# Status emoji
13+
status:
14+
icon: ☕️
15+
16+
# Is this the primary user of the site?
17+
superuser: true
18+
19+
# Role/position/tagline
20+
role: Professor of Artificial Intelligence
21+
22+
# Organizations/Affiliations to show in About widget
23+
organizations:
24+
- name: Stanford University
25+
url: https://www.stanford.edu/
26+
27+
# Short bio (displayed in user profile at end of posts)
28+
bio: My research interests include distributed robotics, mobile computing and programmable matter.
29+
30+
# Social Networking
31+
# Need to use another icon? Simply download the SVG icon to your `assets/media/icons/` folder.
32+
profiles:
33+
- icon: at-symbol
34+
url: 'mailto:[email protected]'
35+
label: E-mail Me
36+
- icon: brands/x
37+
url: https://twitter.com/GetResearchDev
38+
- icon: brands/instagram
39+
url: https://www.instagram.com/
40+
- icon: brands/linkedin
41+
url: https://www.linkedin.com/
42+
# Link to a PDF of your resume/CV - upload it to `static/uploads/resume.pdf`
43+
- icon: academicons/cv
44+
url: uploads/resume.pdf
45+
label: Download my resume
46+
- icon: rss
47+
url: ./post/index.xml
48+
label: Subscribe to my blog via RSS feed
49+
50+
# Highlight the author in author lists? (true/false)
51+
highlight_name: true
52+
53+
# Author's website URL
54+
website: ""
55+
---
56+
57+
Chien Shiung Wu is a professor of artificial intelligence at the Stanford AI Lab. Her research interests include
58+
distributed robotics, mobile computing and programmable matter. She leads the Robotic Neurobiology group, which develops
59+
self-reconfiguring robots, systems of self-organizing robots, and mobile sensor networks.

‎content/authors/admin/avatar.jpg

1.32 MB
Loading

‎content/community/index.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Community
3+
toc: true
4+
reading_time: false
5+
pager: false
6+
---
7+
8+
## Support
9+
10+
Get support fast. Hugo Blox has the largest Hugo community on Discord, consisting of thousands of creators, developers, and startups.
11+
12+
## Docs
13+
14+
- View the [Hugo Blox Documentation](https://docs.hugoblox.com/)
15+
16+
## Live Chat {#chat}
17+
18+
- Join the [Hugo Blox Online Chat](https://discord.gg/z8wNYzb)
19+
- _#using-hugo-blox_ for user help
20+
- _#contributors_ for contributing help
21+
22+
## Feature requests {#feature-requests}
23+
24+
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 👍
25+
26+
## News {#news}
27+
28+
Follow us so you are the first to know when new features and templates are launched:
29+
30+
- [Subscribe to the _#announcement_ channel on Discord](https://discord.gg/z8wNYzb)
31+
- [Follow us on Twitter](https://twitter.com/GetResearchDev)
32+
- [Subscribe to the Hugo Blox blog](https://hugoblox.com/blog/)
33+
34+
## Further Resources
35+
36+
- [Hugo Forums](https://discourse.gohugo.io/) for help installing Hugo and resolving Hugo error messages

‎content/docs/getting-started.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Getting Started
3+
weight: 1
4+
---
5+
6+
## Quick Start from Template
7+
8+
{{% steps %}}
9+
10+
### Initialize a new site
11+
12+
[Click to copy the template on GitHub](https://github.com/new?template_name=theme-documentation&template_owner=HugoBlox)
13+
14+
### Configure your new site
15+
16+
[Configure your site name, description, and menu.](https://docs.hugoblox.com/tutorial/blog/)
17+
18+
### Add your content
19+
20+
[Edit the homepage and add your documentation pages.](https://docs.hugoblox.com/tutorial/blog/)
21+
22+
### Publish your site
23+
24+
[Easily publish your site for free with GitHub Pages](https://docs.hugoblox.com/tutorial/blog/)
25+
26+
{{% /steps %}}
27+
28+
## Next
29+
30+
Let's customize your new site:
31+
32+
{{< cards >}}
33+
{{< card url="../guide/project-structure" title="Project Structure" icon="document-duplicate" >}}
34+
{{< card url="../guide/configuration" title="Configuration" icon="adjustments-vertical" >}}
35+
{{< /cards >}}

‎content/docs/guide/_index.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Guide
3+
weight: 2
4+
sidebar:
5+
open: true
6+
---
7+
8+
{{< cards >}}
9+
{{< card url="project-structure" title="Project Structure" icon="document-duplicate" >}}
10+
{{< card url="configuration" title="Configuration" icon="adjustments-vertical" >}}
11+
{{< /cards >}}

‎content/docs/guide/configuration.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Configuration
3+
weight: 2
4+
---
5+
6+
The configuration of your site can be found in `config/_default/`.
7+
8+
<!--more-->
9+
10+
## Full Documentation
11+
12+
See https://docs.hugoblox.com/getting-started/customize/
13+
14+
## Navigation
15+
16+
### Menu
17+
18+
See https://docs.hugoblox.com/getting-started/customize/#menu-items
19+
20+
## Left Sidebar
21+
22+
Links are automatically generated from the structure of your content directory. Simply add a folder to nest a page.
23+
24+
### Extra Links
25+
26+
Additional links can be added under the `sidebar` section of your `config/_default/menus.yaml`:
27+
28+
```yaml
29+
menu:
30+
sidebar:
31+
- name: "Need help?"
32+
params:
33+
type: separator
34+
weight: 1
35+
- name: "A page"
36+
pageRef: "/page-filename-here"
37+
weight: 2
38+
- name: "An external link ↗"
39+
url: "https://hugoblox.com"
40+
weight: 3
41+
```
42+
43+
## Right Sidebar
44+
45+
A table of contents is automatically generated from the headings your Markdown file.
46+
47+
It can optionally be disabled by setting `toc: false` in the front matter of a page:
48+
49+
```yaml
50+
---
51+
title: My Page
52+
toc: false
53+
---
54+
```

‎content/docs/guide/project-structure.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: Project Structure
3+
weight: 1
4+
---
5+
6+
## Folder Structure
7+
8+
There are **4 main folders for Hugo-based sites**:
9+
10+
- `content/` for your Markdown-formatted content files (homepage, etc.)
11+
- `_index.md` the homepage (**Hugo requires that the homepage and archive pages have an underscore prefix**)
12+
- `assets/`
13+
- `media/` for your media files (images, videos)
14+
- `icons/` upload any custom SVG icons you want to use
15+
- `config/_default/` for your site configuration files
16+
- `hugo.yaml` to configure Hugo (site title, URL, Hugo options, setup per-folder page features)
17+
- `module.yaml` to install or uninstall Hugo themes and plugins
18+
- `params.yaml` to configure Hugo Blox options (SEO, analytics, site features)
19+
- `menus.yaml` to configure your menu links (if the menu is enabled in `params.yaml`)
20+
- `languages.yaml` to configure your site's language or to set language-specific options in a multilingual site
21+
- `static/uploads/` for any files you want visitors to download, such as a PDF
22+
- `go.mod` sets the version of Hugo themes/plugins which your site uses
23+
24+
25+
## Hugo File Naming Convention
26+
27+
Hugo gives us two options to name standard page files: as `TITLE/index.md` or `TITLE.md` where `TITLE` is your page name.
28+
29+
The page name should be lowercase and using hyphens (`-`) instead of spaces.
30+
31+
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.
32+
33+
The homepage is a special case as **Hugo requires the homepage and listing pages to be named** `_index.md`.
34+
35+
## Docs Navigation
36+
37+
The docs navigation is automatically generated based on the content in the `docs/` folder and is sorted alphabetically.
38+
39+
The order of pages can be changed by adding the `weight` parameter in the front matter of your Markdown files.
40+
41+
In the example below, the `example.md` page will appear before the `test.md` page as it has a lower `weight`:
42+
43+
Page `example.md`:
44+
45+
```yaml
46+
---
47+
title: My Example
48+
weight: 1
49+
---
50+
```
51+
52+
Page `test.md`:
53+
54+
```yaml
55+
---
56+
title: My Test
57+
weight: 2
58+
---
59+
```

‎content/docs/guide/shortcodes/_index.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Shortcodes
3+
---
4+
5+
Build the best docs with re-usable components, referred to as Hugo shortcodes:
6+
7+
{{< cards >}}
8+
{{< card url="callout" title="Callout" icon="warning" >}}
9+
{{< card url="cards" title="Cards" icon="card" >}}
10+
{{< card url="toggle" title="Spoiler" icon="chevron-right" >}}
11+
{{< card url="steps" title="Steps" icon="one" >}}
12+
{{< /cards >}}

0 commit comments

Comments
 (0)