drowl87/hextra_mirror
1
0
Fork 1
mirror of https://github.com/imfing/hextra.git synced 2025-06-19 10:04:16 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: fix some spelling mistakes (#159)

Browse Source 
* chore: fix README.md

* docs: minor fix the docs site
This commit is contained in:
Xin
2023-10-27 18:15:06 -04:00
committed by GitHub
parent 15ea31c389
commit 34aecec9d4
5 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
exampleSite/content/docs/getting-started.md
View File

@ -9,7 +9,7 @@ prev: /docs
{{< icon "github" >}}&nbsp;[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">
@ -20,17 +20,17 @@ For more options, check out [Deploy Site](../guide/deploy-site).
## 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.
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
#### 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/)
- [Git](https://git-scm.com/)
@ -67,7 +67,7 @@ module:
### 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
$ hugo new content/_index.md
@ -80,7 +80,7 @@ $ hugo new content/docs/_index.md
$ 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 %}}
@ -93,7 +93,7 @@ To update all Hugo modules in your project to their latest versions, run the fol
$ 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
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
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/)
- [Git](https://git-scm.com/)
@ -136,7 +136,7 @@ theme: hextra
### 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
$ hugo new content/_index.md
@ -149,7 +149,7 @@ $ hugo new content/docs/_index.md
$ 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 %}}
@ -160,7 +160,7 @@ When using [CI/CD](https://en.wikipedia.org/wiki/CI/CD) for Hugo website deploym
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?" %}}
@ -171,7 +171,7 @@ To update all submodules in your repository to their latest commits, run the fol
$ 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
git submodule update --remote themes/hextra