Skip to content

Commit

Permalink
docs: update documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
razonyang committed Jun 20, 2022
1 parent d45e9f7 commit ca8c7e3
Show file tree
Hide file tree
Showing 35 changed files with 623 additions and 232 deletions.
35 changes: 0 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,41 +35,6 @@ There is also a [list of websites that use this theme](https://github.com/razony
| [Troubleshooting](https://hbs.razonyang.com/en/docs/troubleshooting) | [问题排查](https://hbs.razonyang.com/zh-cn/docs/troubleshooting) | [問題排查](https://hbs.razonyang.com/zh-tw/docs/troubleshooting)
| [Get Involved](https://hbs.razonyang.com/en/docs/get-involved) | [参与我们](https://hbs.razonyang.com/zh-cn/docs/get-involved) | [參與我們](https://hbs.razonyang.com/zh-tw/docs/get-involved)

## Features

- [Hugo Pipes](https://gohugo.io/hugo-pipes/): used to generate CSS and JS assets.
- [Flexible and Configurable](https://hbs.razonyang.com/en/docs/configuration).
- Fast and Good User Experience: [Google PageSpeed Insights](https://pagespeed.web.dev/report?url=https://hbs.razonyang.com/en/)'s score is over 95.
- RTL support: [Arabic demo site](https://hbs.razonyang.com/ar/).
- Built on top of custom [Bootstrap 5](https://getbootstrap.com/).
- Responsive.
- [PWA](https://hbs.razonyang.com/en/docs/pwa), AKA progressive web apps.
- Various Palettes: `blue`, `blue-gray`, `brown`, `cyan`, `green`, `indigo`, `orange`, `pink`, `purple`, `red`, `teal`, `yellow`.
- A [Docs Layout](https://hbs.razonyang.com/en/docs/layouts/docs) for publishing project documentation, notes, digital gardens, zettelkastens etc.
- Light/Dark Mode.
- Font Size Switcher.
- Multilingual(I18N).
- [Search](https://hbs.razonyang.com/en/docs/search).
- Pinning Posts.
- Footer Menu.
- Code Block Panel: copy code, line number, line wrap and expand.
- Breadcrumb.
- [Archive](https://hbs.razonyang.com/en/docs/archives).
- [Image Viewer](https://hbs.razonyang.com/en/docs/image-viewer).
- [Image Processing](https://hbs.razonyang.com/en/docs/image-processing): resize and align images.
- Resources Lazy Loading: `image` and `iframe`.
- [Syntax Highlighting](https://hbs.razonyang.com/en/docs/look-and-feel#syntax-highlighting).
- [Reward Widget](https://hbs.razonyang.com/en/docs/widgets/reward), AKA Buy Me a Coffee: any platform that supports QR code is supported.
- Table of Contents.
- [Comments](https://hbs.razonyang.com/en/docs/widgets/comments): Disqus and Utterances can be used out of box, you can also integrate with other comments services.
- [Custom Assets](https://hbs.razonyang.com/en/docs/advanced/custom-assets): custom CSS and JS.
- [Hooks](https://hbs.razonyang.com/en/docs/advanced/hooks): provides ability to add custom code on page.
- [Social Links](https://hbs.razonyang.com/en/docs/widgets/social-links).
- [Various Shortcodes](https://hbs.razonyang.com/en/docs/shortcodes).
- [Twitter Cards](https://gohugo.io/templates/internal/#configure-twitter-cards) and [Open Graph](https://gohugo.io/templates/internal/#configure-open-graph).
- [Creative Commons License](https://creativecommons.org/licenses/).
- [Contact Form](https://hbs.razonyang.com/en/docs/layouts/contact-form).
- Numberify Headings Automatically.

## Funding

Expand Down
3 changes: 3 additions & 0 deletions exampleSite/content/docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
+++
title = "Docs"
+++
3 changes: 3 additions & 0 deletions exampleSite/content/docs/_index.zh-cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
+++
title = "文档"
+++
3 changes: 3 additions & 0 deletions exampleSite/content/docs/_index.zh-tw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
+++
title = "檔案"
+++
27 changes: 27 additions & 0 deletions exampleSite/content/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
+++
title = "Getting Started"
linkTitleIcon = '<i class="fas fa-book fa-fw"></i>'
date = 2021-12-04T10:43:39+08:00
featured = true
comment = true
toc = true
reward = true
pinned = true
categories = [
]
tags = [
"Installation",
"Prerequisites"
]
series = [
"Docs"
]
images = []
weight = 1000
aliases = [
"/en/posts/getting-started"
]
[menu.footer]
parent = "docs"
weight = 1
+++
27 changes: 27 additions & 0 deletions exampleSite/content/docs/getting-started/_index.zh-cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
+++
title = "快速入门"
linkTitleIcon = '<i class="fas fa-book fa-fw"></i>'
date = 2021-12-04T10:43:39+08:00
featured = true
comment = true
toc = true
reward = true
pinned = true
categories = [
]
tags = [
"Installation",
"Prerequisites"
]
series = [
"Docs"
]
images = []
weight = 1000
aliases = [
"/zh-cn/posts/getting-started"
]
[menu.footer]
parent = "docs"
weight = 1
+++
27 changes: 27 additions & 0 deletions exampleSite/content/docs/getting-started/_index.zh-tw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
+++
title = "快速入門"
linkTitleIcon = '<i class="fas fa-book fa-fw"></i>'
date = 2021-12-04T10:43:39+08:00
featured = true
comment = true
toc = true
reward = true
pinned = true
categories = [
]
tags = [
"Installation",
"Prerequisites"
]
series = [
"Docs"
]
images = []
weight = 1000
aliases = [
"/zh-tw/posts/getting-started"
]
[menu.footer]
parent = "docs"
weight = 1
+++
65 changes: 0 additions & 65 deletions exampleSite/content/docs/getting-started/index.md

This file was deleted.

63 changes: 0 additions & 63 deletions exampleSite/content/docs/getting-started/index.zh-cn.md

This file was deleted.

63 changes: 0 additions & 63 deletions exampleSite/content/docs/getting-started/index.zh-tw.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
title = "Installation"
date = 2021-12-04T10:43:39+08:00
weight = 990
weight = 80
+++
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
title = "安装"
date = 2021-12-04T10:43:39+08:00
weight = 990
weight = 80
+++
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
title = "安裝"
date = 2021-12-04T10:43:39+08:00
weight = 990
weight = 80
+++
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ weight = 80

This article refers to the traditional installation method of cloning the theme locally as Git submodule.
It describes how to install, upgrade the theme, and write new articles.
While this installation method is still widely used, we recommend to install the theme as [Hugo module]({{< ref "/docs/installation/hugo-module" >}}).
While this installation method is still widely used, we recommend to install the theme as [Hugo module]({{< ref "/docs/getting-started/installation/hugo-module" >}}).

## Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ weight = 80

This article refers to the traditional installation method of cloning the theme locally as Git submodule.
It describes how to install, upgrade the theme, and write new articles.
While this installation method is still widely used, we recommend to install the theme as [Hugo module]({{< ref "/docs/installation/hugo-module" >}}).
While this installation method is still widely used, we recommend to install the theme as [Hugo module]({{< ref "/docs/getting-started/installation/hugo-module" >}}).

## 安装

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ weight = 80

This article refers to the traditional installation method of cloning the theme locally as Git submodule.
It describes how to install, upgrade the theme, and write new articles.
While this installation method is still widely used, we recommend to install the theme as [Hugo module]({{< ref "/docs/installation/hugo-module" >}}).
While this installation method is still widely used, we recommend to install the theme as [Hugo module]({{< ref "/docs/getting-started/installation/hugo-module" >}}).

## 安裝

Expand Down
Loading

0 comments on commit ca8c7e3

Please sign in to comment.