Skip to content

Commit 34aecec

Browse files
authored
docs: fix some spelling mistakes (#159)
* chore: fix README.md * docs: minor fix the docs site
1 parent 15ea31c commit 34aecec

File tree

5 files changed

+24
-24
lines changed

5 files changed

+24
-24
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Demo → [imfing.github.io/hextra](https://imfing.github.io/hextra/)
1717
## Features
1818

1919
- **Beautiful Design** - Inspired by Nextra, Hextra utilizes Tailwind CSS to offer a modern design that makes your site look outstanding.
20-
- **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.
21-
- **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.
22-
- **Full-text Search** - Built-in offline full-text search powered by FlexSearch, no additional configuration required.
23-
- **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.
20+
- **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.
21+
- **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.
22+
- **Full-text Search** - Built-in offline full-text search powered by FlexSearch, no extra configuration required.
23+
- **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.
2424
- **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.
2525

2626
## Quick Start
@@ -39,7 +39,7 @@ Refer to the [documentation](https://imfing.github.io/hextra/docs) for more info
3939

4040
## Contributing
4141

42-
Contributions are welcome!
42+
Contributions are welcome.
4343
Check out the [contributing guide](.github/CONTRIBUTING.md) to get started.
4444

4545
## License

exampleSite/content/docs/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ title: Introduction
1010
## What is Hextra?
1111

1212
Hextra is a modern, fast and batteries-included [Hugo][hugo] theme built with [Tailwind CSS][tailwind-css].
13-
Designed for building beautiful websites for documentation, blogs and websites, it provides out-of-the-box features and flexibility to meet various requirements.
13+
Designed for building beautiful websites for documentation, blogs, and websites, it provides out-of-the-box features and flexibility to meet various requirements.
1414

1515
## Features
1616

1717
- **Beautiful Design** - Inspired by Nextra, Hextra utilizes Tailwind CSS to offer a modern design that makes your site look outstanding.
18-
- **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.
19-
- **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.
18+
- **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.
19+
- **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.
2020
- **Full-text Search** - Built-in offline full-text search powered by FlexSearch, no additional configuration required.
21-
- **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.
21+
- **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.
2222
- **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.
2323

2424
## Questions or Feedback?

exampleSite/content/docs/getting-started.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ prev: /docs
99

1010
{{< icon "github" >}}&nbsp;[imfing/hextra-starter-template](https://github.com/imfing/hextra-starter-template)
1111

12-
You will be able to quickly get started by using the above template repository.
12+
You could quickly get started by using the above template repository.
1313

1414
<img src="https://docs.github.com/assets/cb-77734/mw-1440/images/help/repository/use-this-template-button.webp" width="500">
1515

@@ -20,17 +20,17 @@ For more options, check out [Deploy Site](../guide/deploy-site).
2020

2121
## Start as New Project
2222

23-
There are two main ways to add the Hextra theme to your Hugo project.
23+
There are two main ways to add the Hextra theme to your Hugo project:
2424

2525
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.
2626

27-
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.
27+
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.
2828

2929
### Setup Hextra as Hugo module
3030

3131
#### Prerequisites
3232

33-
Before starting, you need to have the following softwares installed:
33+
Before starting, you need to have the following software installed:
3434

3535
- [Hugo (extended version)](https://gohugo.io/installation/)
3636
- [Git](https://git-scm.com/)
@@ -67,7 +67,7 @@ module:
6767
6868
### Create your first content pages
6969
70-
Let's create new content page for the home page and the documentation page:
70+
Create new content page for the home page and the documentation page:
7171
7272
```shell
7373
$ hugo new content/_index.md
@@ -80,7 +80,7 @@ $ hugo new content/docs/_index.md
8080
$ hugo server --buildDrafts --disableFastRender
8181
```
8282

83-
Voila! You can see your new site at `http://localhost:1313/`.
83+
Voila, your new site preview is available at `http://localhost:1313/`.
8484

8585
{{% /steps %}}
8686

@@ -93,7 +93,7 @@ To update all Hugo modules in your project to their latest versions, run the fol
9393
$ hugo mod get -u
9494
```
9595

96-
To update only Hextra to the [latest released version](https://github.com/imfing/hextra/releases), run the following command:
96+
To update Hextra to the [latest released version](https://github.com/imfing/hextra/releases), run the following command:
9797

9898
```shell
9999
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
107107

108108
#### Prerequisites
109109

110-
Before starting, you need to have the following softwares installed:
110+
Before starting, you need to have the following software installed:
111111

112112
- [Hugo (extended version)](https://gohugo.io/installation/)
113113
- [Git](https://git-scm.com/)
@@ -136,7 +136,7 @@ theme: hextra
136136
137137
### Create your first content pages
138138
139-
Let's create new content page for the home page and the documentation page:
139+
Create new content page for the home page and the documentation page:
140140
141141
```shell
142142
$ hugo new content/_index.md
@@ -149,7 +149,7 @@ $ hugo new content/docs/_index.md
149149
$ hugo server --buildDrafts --disableFastRender
150150
```
151151

152-
Voila! You can see your new site at `http://localhost:1313/`.
152+
Your new site preview is available at `http://localhost:1313/`.
153153

154154
{{% /steps %}}
155155

@@ -160,7 +160,7 @@ When using [CI/CD](https://en.wikipedia.org/wiki/CI/CD) for Hugo website deploym
160160
git submodule update --init
161161
```
162162

163-
Failure to run this command will result in the theme folder not being populated with Hextra theme files, leading to a build failure.
163+
Failure to run this command results in the theme folder not being populated with Hextra theme files, leading to a build failure.
164164

165165

166166
{{% details title="How to update theme?" %}}
@@ -171,7 +171,7 @@ To update all submodules in your repository to their latest commits, run the fol
171171
$ git submodule update --remote
172172
```
173173

174-
To update only Hextra to the latest commit, run the following command:
174+
To update Hextra to the latest commit, run the following command:
175175

176176
```shell
177177
git submodule update --remote themes/hextra

exampleSite/content/docs/guide/diagrams.zh-cn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ weight: 6
44
next: /docs/guide/shortcodes
55
---
66

7-
目前,Hextra 支持 [Mermain](#mermaid) 的图表。
7+
目前,Hextra 支持 [Mermaid](#mermaid) 的图表。
88

99
<!--more-->
1010

1111
## Mermaid
1212

1313
[Mermaid](https://github.com/mermaid-js/mermaid#readme) 是一个基于 JavaScript 的图表绘制工具,它的文本定义和 Markdown 类似,可在浏览器中动态创建图表。例如:流程图、序列图、饼图等。
1414

15-
在 Hextra 中使用 Mermain 就像使用代码块一样简单:
15+
在 Hextra 中使用 Mermaid 就像使用代码块一样简单:
1616

1717
````markdown
1818
```mermaid

exampleSite/content/docs/guide/syntax-highlighting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ By default, copy button is enabled for code blocks.
8686

8787
## Supported Languages
8888

89-
For a list of supported languages, please see [Chroma's documentation](https://github.com/alecthomas/chroma#supported-languages).
89+
For a list of supported languages, please see the [Chroma documentation](https://github.com/alecthomas/chroma#supported-languages).

0 commit comments

Comments
 (0)