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 1e6a3b0 commit dbf6ac4
Show file tree
Hide file tree
Showing 21 changed files with 114 additions and 405 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Deploy website to GitHub Pages

env:
WC_HUGO_VERSION: '0.119.0'
WC_HUGO_VERSION: '0.122.0'

on:
# Trigger the workflow every time you push to the `main` branch
Expand Down Expand Up @@ -51,6 +51,8 @@ jobs:
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:
Expand Down
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,32 @@
# [Hugo Documentation Theme](https://github.com/HugoBlox/theme-documentation)
# [Hugo Docs Theme](https://github.com/HugoBlox/theme-documentation)

[![Screenshot](./preview.png)](https://hugoblox.com/templates/)
[![Screenshot](./.github/preview.png)](https://hugoblox.com/templates/details/docs/)

The **Documentation** starter template empowers you to easily create **product documentation**, **digital books**, **personal notes**, and **knowledge bases**.
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!

[![Get Started](https://img.shields.io/badge/-Get%20started-ff4655?style=for-the-badge)](https://hugoblox.com/hugo-themes/)
**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/wowchemy)
[![Twitter Follow](https://img.shields.io/twitter/follow/GetResearchDev?label=Follow%20on%20Twitter)](https://twitter.com/GetResearchDev)

[Check out the latest demo](https://docs.hugoblox.com/) of what you'll get in less than 10 minutes, or [get inspired by how others are using this template](https://hugoblox.com/creators/).
[Check out the latest demo](https://docs.hugoblox.com/) of what you'll get in less than 10 minutes, or [view the showcase](https://hugoblox.com/creators/).

The integrated [**Wowchemy**](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.
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/hugo-themes/)
- 👉 [**Get Started**](https://hugoblox.com/templates/details/docs/)
- 📚 [View the **documentation**](https://docs.hugoblox.com/)
- 💬 [Chat with the **Wowchemy research community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
- ⬇️ **Automatically import citations from BibTeX** with the [Hugo Academic CLI](https://github.com/GetRD/academic-file-converter)
- 🐦 Share your new site with the community: [@wowchemy](https://twitter.com/wowchemy) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithWowchemy](https://twitter.com/search?q=%23MadeWithWowchemy&src=typed_query)
- 💬 [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/hugo-tutorials/update/) and [Release Notes](https://github.com/HugoBlox/hugo-blox-builder/releases)
- ⬆️ **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 Wowchemy website builder and themes 🐧
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 GitHub Sponsor, unlocking awesome perks such as _exclusive academic templates and widgets_](https://github.com/sponsors/gcushen)
### [❤️ Click here to become a Sponsor, unlocking awesome perks such as _exclusive_ templates and blox_](https://hugoblox.com/sponsor/)
Binary file modified assets/media/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 32 additions & 3 deletions config/_default/hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# 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: 'My Project' # Website name
title: "Hugo Docs" # Website name
baseURL: 'https://example.com/' # Website URL

############################
Expand All @@ -16,6 +16,31 @@ cascade:
path: /docs/**
editable: true
show_breadcrumb: true
# Blog post options
- _target:
path: /post/**
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
# Blog section options
- _target:
path: /post/*
kind: section
# Change url to /blog/
url: /blog/
# Set the listing view
view: date-title-summary

############################
## LANGUAGE
Expand All @@ -30,24 +55,28 @@ removePathAccents: true
## ADVANCED
############################

build:
writeStats: true
enableGitInfo: false
summaryLength: 30
paginate: 10
enableEmoji: true
enableRobotsTXT: true
footnotereturnlinkcontents: <sup>^</sup>
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, JSON, WebAppManifest, headers, redirects]
home: [HTML, RSS, WebAppManifest, headers, redirects]
page: [HTML]
section: [HTML, RSS]
imaging:
resampleFilter: lanczos
quality: 75
quality: 85
anchor: smart
timeout: 600000
taxonomies:
Expand Down
26 changes: 24 additions & 2 deletions config/_default/menus.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Navigation Links
# To link a homepage widget, specify the URL as a hash `#` followed by the filename of the
# desired widget in your `content/home/` folder.
# The weight parameter defines the order that the links will appear in.

main:
Expand All @@ -10,3 +8,27 @@ main:
- 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
2 changes: 1 addition & 1 deletion config/_default/module.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

imports:
- path: github.com/HugoBlox/hugo-blox-builder/modules/blox-plugin-netlify
- path: github.com/HugoBlox/hugo-blox-builder/modules/blox-bootstrap/v5
- path: github.com/HugoBlox/hugo-blox-builder/modules/blox-tailwind
59 changes: 24 additions & 35 deletions config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,92 +4,81 @@
# This file is formatted using YAML syntax - learn more at https://learnxinyminutes.com/docs/yaml/

# Appearance

appearance:
theme_day: minimal
theme_night: minimal
font: minimal
font_size: L
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 Builder.'
description: 'A highly-customizable Hugo documentation theme powered by Hugo Blox website builder.'
twitter: 'GetResearchDev'
analytics:
google_analytics: ''
baidu_tongji: ''
google_tag_manager: ''
microsoft_clarity: ''
baidu_tongji: ''
plausible: ''
fathom: ''
pirsch: ''
verification:
google: ''
baidu: ''

# Site header

header:
navbar:
enable: true
align: l
show_logo: true
show_language: false
show_day_night: 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
highlight_active_link: true
show_theme_chooser: true

# Site footer
footer:
copyright:
notice: '© {year} Me. This work is licensed under {license}'
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:
syntax_highlighter:
theme_light: github-light
theme_dark: dracula
math:
enable: false
privacy_pack:
enable: false
repository:
url: 'https://github.com/wowchemy/hugo-documentation-theme'
content_dir: content
branch: main
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/<USERNAME>/<REPO>/issues/new).'
negative: 'Sorry to hear that. [Please tell us how we can improve](https://github.com/<USERNAME>/<REPO>/issues/new).'
comment:
provider: ''
disqus:
shortname: ''
show_count: true
commento:
url: ''
giscus:
repo: ''
repo_id: ''
category: ''
category_id: ''
search:
provider: wowchemy
algolia:
app_id: ''
api_key: ''
index_name: ''
show_logo: false
17 changes: 12 additions & 5 deletions content/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
---
title: Docs
type: book # Do not modify.
toc: false
linkTitle: Documentation
title: Introduction
---

Welcome to the _Project Docs_ template!
👋 Welcome to the demo of the Hugo Blox Documentation template!

{{< cta cta_text="👉 Get Started with Chapter 1" cta_link="chapter1" >}}
<!--more-->

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 >}}
56 changes: 0 additions & 56 deletions content/docs/chapter1/_index.md

This file was deleted.

Loading

0 comments on commit dbf6ac4

Please sign in to comment.