forked from drowl87/hextra_mirror
docs: fix some spelling mistakes (#159)
* chore: fix README.md * docs: minor fix the docs site
This commit is contained in:
parent
15ea31c389
commit
34aecec9d4
10
README.md
10
README.md
@ -17,10 +17,10 @@ Demo → [imfing.github.io/hextra](https://imfing.github.io/hextra/)
|
|||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Beautiful Design** - Inspired by Nextra, Hextra utilizes Tailwind CSS to offer a modern design that makes your site look outstanding.
|
- **Beautiful Design** - Inspired by Nextra, Hextra utilizes Tailwind CSS to offer a modern design that makes your site look outstanding.
|
||||||
- **Responsive Layout and Dark Mode** - It looks great on all devices, from mobile, tablet to desktop. Dark mode is also supported to accomodate various lighting conditions.
|
- **Responsive Layout and Dark Mode** - It looks great on all devices, from mobile to desktop. Dark mode is also supported to accommodate various lighting conditions.
|
||||||
- **Fast and Lightweight** - Powered by Hugo, a lightning-fast static-site generator housed in a single binary file, Hextra keeps its footprint minimal. No Javascript or Node.js are needed to use it.
|
- **Fast and Lightweight** - Powered by Hugo, a lightning-fast static-site generator housed in a single binary file, Hextra keeps its footprint minimal. No JavaScript or Node.js are needed to use it.
|
||||||
- **Full-text Search** - Built-in offline full-text search powered by FlexSearch, no additional configuration required.
|
- **Full-text Search** - Built-in offline full-text search powered by FlexSearch, no extra configuration required.
|
||||||
- **Battery-included** - Markdown, syntax highlighting, LaTeX math formulae, diagrams and Shortcodes elements to enhance your content. Table of contents, breadcumbs, pagination, sidebar navigation and more are all automatically generated.
|
- **Battery-included** - Markdown, syntax highlighting, LaTeX math formulae, diagrams and Shortcodes elements to enhance your content. Table of contents, breadcrumbs, pagination, sidebar navigation and more are all automatically generated.
|
||||||
- **Multi-language and SEO Ready** - Multi-language sites made easy with Hugo's multilingual mode. Out-of-the-box support is included for SEO tags, Open Graph, and Twitter Cards.
|
- **Multi-language and SEO Ready** - Multi-language sites made easy with Hugo's multilingual mode. Out-of-the-box support is included for SEO tags, Open Graph, and Twitter Cards.
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
@ -39,7 +39,7 @@ Refer to the [documentation](https://imfing.github.io/hextra/docs) for more info
|
|||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Contributions are welcome!
|
Contributions are welcome.
|
||||||
Check out the [contributing guide](.github/CONTRIBUTING.md) to get started.
|
Check out the [contributing guide](.github/CONTRIBUTING.md) to get started.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
@ -10,15 +10,15 @@ title: Introduction
|
|||||||
## What is Hextra?
|
## What is Hextra?
|
||||||
|
|
||||||
Hextra is a modern, fast and batteries-included [Hugo][hugo] theme built with [Tailwind CSS][tailwind-css].
|
Hextra is a modern, fast and batteries-included [Hugo][hugo] theme built with [Tailwind CSS][tailwind-css].
|
||||||
Designed for building beautiful websites for documentation, blogs and websites, it provides out-of-the-box features and flexibility to meet various requirements.
|
Designed for building beautiful websites for documentation, blogs, and websites, it provides out-of-the-box features and flexibility to meet various requirements.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Beautiful Design** - Inspired by Nextra, Hextra utilizes Tailwind CSS to offer a modern design that makes your site look outstanding.
|
- **Beautiful Design** - Inspired by Nextra, Hextra utilizes Tailwind CSS to offer a modern design that makes your site look outstanding.
|
||||||
- **Responsive Layout and Dark Mode** - It looks great on all devices, from mobile, tablet to desktop. Dark mode is also supported to accomodate various lighting conditions.
|
- **Responsive Layout and Dark Mode** - It looks great on all devices, from mobile, tablet to desktop. Dark mode is also supported to accommodate various lighting conditions.
|
||||||
- **Fast and Lightweight** - Powered by Hugo, a lightning-fast static-site generator housed in a single binary file, Hextra keeps its footprint minimal. No Javascript or Node.js are needed to use it.
|
- **Fast and Lightweight** - Powered by Hugo, a lightning-fast static-site generator housed in a single binary file, Hextra keeps its footprint minimal. No JavaScript or Node.js are needed to use it.
|
||||||
- **Full-text Search** - Built-in offline full-text search powered by FlexSearch, no additional configuration required.
|
- **Full-text Search** - Built-in offline full-text search powered by FlexSearch, no additional configuration required.
|
||||||
- **Battery-included** - Markdown, syntax highlighting, LaTeX math formulae, diagrams and Shortcodes elements to enhance your content. Table of contents, breadcumbs, pagination, sidebar navigation and more are all automatically generated.
|
- **Battery-included** - Markdown, syntax highlighting, LaTeX math formulae, diagrams and Shortcodes elements to enhance your content. Table of contents, breadcrumbs, pagination, sidebar navigation and more are all automatically generated.
|
||||||
- **Multi-language and SEO Ready** - Multi-language sites made easy with Hugo's multilingual mode. Out-of-the-box support is included for SEO tags, Open Graph, and Twitter Cards.
|
- **Multi-language and SEO Ready** - Multi-language sites made easy with Hugo's multilingual mode. Out-of-the-box support is included for SEO tags, Open Graph, and Twitter Cards.
|
||||||
|
|
||||||
## Questions or Feedback?
|
## Questions or Feedback?
|
||||||
|
@ -9,7 +9,7 @@ prev: /docs
|
|||||||
|
|
||||||
{{< icon "github" >}} [imfing/hextra-starter-template](https://github.com/imfing/hextra-starter-template)
|
{{< icon "github" >}} [imfing/hextra-starter-template](https://github.com/imfing/hextra-starter-template)
|
||||||
|
|
||||||
You will be able to quickly get started by using the above template repository.
|
You could quickly get started by using the above template repository.
|
||||||
|
|
||||||
<img src="https://docs.github.com/assets/cb-77734/mw-1440/images/help/repository/use-this-template-button.webp" width="500">
|
<img src="https://docs.github.com/assets/cb-77734/mw-1440/images/help/repository/use-this-template-button.webp" width="500">
|
||||||
|
|
||||||
@ -20,17 +20,17 @@ For more options, check out [Deploy Site](../guide/deploy-site).
|
|||||||
|
|
||||||
## Start as New Project
|
## Start as New Project
|
||||||
|
|
||||||
There are two main ways to add the Hextra theme to your Hugo project.
|
There are two main ways to add the Hextra theme to your Hugo project:
|
||||||
|
|
||||||
1. **Hugo Modules (Recommended)**: The simplest and recommended method. [Hugo modules](https://gohugo.io/hugo-modules/) let you pull in the theme directly from its online source. Theme is downloaded automatically and managed by Hugo.
|
1. **Hugo Modules (Recommended)**: The simplest and recommended method. [Hugo modules](https://gohugo.io/hugo-modules/) let you pull in the theme directly from its online source. Theme is downloaded automatically and managed by Hugo.
|
||||||
|
|
||||||
2. **Git Submodule**: Alternatively, add Hextra as a [Git Submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). The theme will be downloaded by Git and stored in your project's `themes` folder.
|
2. **Git Submodule**: Alternatively, add Hextra as a [Git Submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). The theme is downloaded by Git and stored in your project's `themes` folder.
|
||||||
|
|
||||||
### Setup Hextra as Hugo module
|
### Setup Hextra as Hugo module
|
||||||
|
|
||||||
#### Prerequisites
|
#### Prerequisites
|
||||||
|
|
||||||
Before starting, you need to have the following softwares installed:
|
Before starting, you need to have the following software installed:
|
||||||
|
|
||||||
- [Hugo (extended version)](https://gohugo.io/installation/)
|
- [Hugo (extended version)](https://gohugo.io/installation/)
|
||||||
- [Git](https://git-scm.com/)
|
- [Git](https://git-scm.com/)
|
||||||
@ -67,7 +67,7 @@ module:
|
|||||||
|
|
||||||
### Create your first content pages
|
### Create your first content pages
|
||||||
|
|
||||||
Let's create new content page for the home page and the documentation page:
|
Create new content page for the home page and the documentation page:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ hugo new content/_index.md
|
$ hugo new content/_index.md
|
||||||
@ -80,7 +80,7 @@ $ hugo new content/docs/_index.md
|
|||||||
$ hugo server --buildDrafts --disableFastRender
|
$ hugo server --buildDrafts --disableFastRender
|
||||||
```
|
```
|
||||||
|
|
||||||
Voila! You can see your new site at `http://localhost:1313/`.
|
Voila, your new site preview is available at `http://localhost:1313/`.
|
||||||
|
|
||||||
{{% /steps %}}
|
{{% /steps %}}
|
||||||
|
|
||||||
@ -93,7 +93,7 @@ To update all Hugo modules in your project to their latest versions, run the fol
|
|||||||
$ hugo mod get -u
|
$ hugo mod get -u
|
||||||
```
|
```
|
||||||
|
|
||||||
To update only Hextra to the [latest released version](https://github.com/imfing/hextra/releases), run the following command:
|
To update Hextra to the [latest released version](https://github.com/imfing/hextra/releases), run the following command:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
hugo mod get -u github.com/imfing/hextra
|
hugo mod get -u github.com/imfing/hextra
|
||||||
@ -107,7 +107,7 @@ See [Hugo Modules](https://gohugo.io/hugo-modules/use-modules/#update-all-module
|
|||||||
|
|
||||||
#### Prerequisites
|
#### Prerequisites
|
||||||
|
|
||||||
Before starting, you need to have the following softwares installed:
|
Before starting, you need to have the following software installed:
|
||||||
|
|
||||||
- [Hugo (extended version)](https://gohugo.io/installation/)
|
- [Hugo (extended version)](https://gohugo.io/installation/)
|
||||||
- [Git](https://git-scm.com/)
|
- [Git](https://git-scm.com/)
|
||||||
@ -136,7 +136,7 @@ theme: hextra
|
|||||||
|
|
||||||
### Create your first content pages
|
### Create your first content pages
|
||||||
|
|
||||||
Let's create new content page for the home page and the documentation page:
|
Create new content page for the home page and the documentation page:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ hugo new content/_index.md
|
$ hugo new content/_index.md
|
||||||
@ -149,7 +149,7 @@ $ hugo new content/docs/_index.md
|
|||||||
$ hugo server --buildDrafts --disableFastRender
|
$ hugo server --buildDrafts --disableFastRender
|
||||||
```
|
```
|
||||||
|
|
||||||
Voila! You can see your new site at `http://localhost:1313/`.
|
Your new site preview is available at `http://localhost:1313/`.
|
||||||
|
|
||||||
{{% /steps %}}
|
{{% /steps %}}
|
||||||
|
|
||||||
@ -160,7 +160,7 @@ When using [CI/CD](https://en.wikipedia.org/wiki/CI/CD) for Hugo website deploym
|
|||||||
git submodule update --init
|
git submodule update --init
|
||||||
```
|
```
|
||||||
|
|
||||||
Failure to run this command will result in the theme folder not being populated with Hextra theme files, leading to a build failure.
|
Failure to run this command results in the theme folder not being populated with Hextra theme files, leading to a build failure.
|
||||||
|
|
||||||
|
|
||||||
{{% details title="How to update theme?" %}}
|
{{% details title="How to update theme?" %}}
|
||||||
@ -171,7 +171,7 @@ To update all submodules in your repository to their latest commits, run the fol
|
|||||||
$ git submodule update --remote
|
$ git submodule update --remote
|
||||||
```
|
```
|
||||||
|
|
||||||
To update only Hextra to the latest commit, run the following command:
|
To update Hextra to the latest commit, run the following command:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
git submodule update --remote themes/hextra
|
git submodule update --remote themes/hextra
|
||||||
|
@ -4,7 +4,7 @@ weight: 6
|
|||||||
next: /docs/guide/shortcodes
|
next: /docs/guide/shortcodes
|
||||||
---
|
---
|
||||||
|
|
||||||
目前,Hextra 支持 [Mermain](#mermaid) 的图表。
|
目前,Hextra 支持 [Mermaid](#mermaid) 的图表。
|
||||||
|
|
||||||
<!--more-->
|
<!--more-->
|
||||||
|
|
||||||
@ -12,7 +12,7 @@ next: /docs/guide/shortcodes
|
|||||||
|
|
||||||
[Mermaid](https://github.com/mermaid-js/mermaid#readme) 是一个基于 JavaScript 的图表绘制工具,它的文本定义和 Markdown 类似,可在浏览器中动态创建图表。例如:流程图、序列图、饼图等。
|
[Mermaid](https://github.com/mermaid-js/mermaid#readme) 是一个基于 JavaScript 的图表绘制工具,它的文本定义和 Markdown 类似,可在浏览器中动态创建图表。例如:流程图、序列图、饼图等。
|
||||||
|
|
||||||
在 Hextra 中使用 Mermain 就像使用代码块一样简单:
|
在 Hextra 中使用 Mermaid 就像使用代码块一样简单:
|
||||||
|
|
||||||
````markdown
|
````markdown
|
||||||
```mermaid
|
```mermaid
|
||||||
|
@ -86,4 +86,4 @@ By default, copy button is enabled for code blocks.
|
|||||||
|
|
||||||
## Supported Languages
|
## Supported Languages
|
||||||
|
|
||||||
For a list of supported languages, please see [Chroma's documentation](https://github.com/alecthomas/chroma#supported-languages).
|
For a list of supported languages, please see the [Chroma documentation](https://github.com/alecthomas/chroma#supported-languages).
|
||||||
|
Loading…
x
Reference in New Issue
Block a user