minor markdown, capitalization and spelling fixes (#1183)

This commit is contained in:
Christian Oliff authored and GitHub committed 2020-08-03 12:48:59 +09:00
1 parent fd4a103bfd
commit c91be3403e
5 files changed
+5 -13

No files matched your search

@@ -18,8 +18,8 @@ Page Bundles are a way to group [Page Resources](/content-management/page-resour
A Page Bundle can be one of: A Page Bundle can be one of:
- Leaf Bundle (leaf means it has no children) - Leaf Bundle (leaf means it has no children)
- Branch Bundle (home page, section, taxonomy terms, taxonomy list) - Branch Bundle (home page, section, taxonomy terms, taxonomy list)
| | Leaf Bundle | Branch Bundle | | | Leaf Bundle | Branch Bundle |
|-------------------------------------|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |-------------------------------------|----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -16,14 +16,12 @@ aliases: [/extras/highlighting/,/extras/highlight/,/tools/syntax-highlighting/]
toc: true toc: true
--- ---
Hugo uses [Chroma](https://github.com/alecthomas/chroma) as its code highlighter; it is built in Go and is really, really fast -- and for the most important parts compatible with Pygments we used before. Hugo uses [Chroma](https://github.com/alecthomas/chroma) as its code highlighter; it is built in Go and is really, really fast -- and for the most important parts compatible with Pygments we used before.
## Configure Syntax Highlighter ## Configure Syntax Highlighter
See [Configure Highlight](/getting-started/configuration-markup#highlight). See [Configure Highlight](/getting-started/configuration-markup#highlight).
## Generate Syntax Highlighter CSS ## Generate Syntax Highlighter CSS
If you run with `pygmentsUseClasses=true` in your site config, you need a style sheet. If you run with `pygmentsUseClasses=true` in your site config, you need a style sheet.
@@ -36,7 +34,6 @@ hugo gen chromastyles --style=monokai > syntax.css
Run `hugo gen chromastyles -h` for more options. See https://xyproto.github.io/splash/docs/ for a gallery of available styles. Run `hugo gen chromastyles -h` for more options. See https://xyproto.github.io/splash/docs/ for a gallery of available styles.
## Highlight Shortcode ## Highlight Shortcode
Highlighting is carried out via the [built-in shortcode](/content-management/shortcodes/) `highlight`. `highlight` takes exactly one required parameter for the programming language to be highlighted and requires a closing shortcode. Note that `highlight` is *not* used for client-side javascript highlighting. Highlighting is carried out via the [built-in shortcode](/content-management/shortcodes/) `highlight`. `highlight` takes exactly one required parameter for the programming language to be highlighted and requires a closing shortcode. Note that `highlight` is *not* used for client-side javascript highlighting.
@@ -80,8 +77,6 @@ func GetTitleFunc(style string) func(s string) string {
} }
{{< / highlight >}} {{< / highlight >}}
## Highlight Template Func ## Highlight Template Func
See [Highlight](/functions/highlight/). See [Highlight](/functions/highlight/).
-1
View File
@@ -24,7 +24,6 @@ A collection of all themes created by the Hugo community, including screenshots
Another great site for Hugo themes is [jamstackthemes.dev/](https://jamstackthemes.dev/ssg/hugo/). Another great site for Hugo themes is [jamstackthemes.dev/](https://jamstackthemes.dev/ssg/hugo/).
### Add Your Theme to the Repo ### Add Your Theme to the Repo
In order to add your Hugo theme to [themes.gohugo.io] please [open up a new issue in the theme repository](https://github.com/gohugoio/hugoThemes/issues/new?template=theme-submission.md). **Please make sure that you've read the theme submission guidelines in the [README](https://github.com/gohugoio/hugoThemes/blob/master/README.md#adding-a-theme-to-the-list) of the hugoThemes repository.** In order to add your Hugo theme to [themes.gohugo.io] please [open up a new issue in the theme repository](https://github.com/gohugoio/hugoThemes/issues/new?template=theme-submission.md). **Please make sure that you've read the theme submission guidelines in the [README](https://github.com/gohugoio/hugoThemes/blob/master/README.md#adding-a-theme-to-the-list) of the hugoThemes repository.**
@@ -56,11 +56,10 @@ In the rendered page response, the `https://__baseurl__` will be replaced with y
We will now create a git repository and then push our code to Bitbucket. In Bitbucket, create a repository. We will now create a git repository and then push our code to Bitbucket. In Bitbucket, create a repository.
![][1] ![Bitbucket Screenshot][1]
[1]: /images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-create-repo.png [1]: /images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-create-repo.png
``` ```
# initialize new git repository # initialize new git repository
git init git init
@@ -133,11 +132,10 @@ Your code will be committed to Bitbucket, Bitbucket Pipelines will run your buil
At this point, you can now create and edit blog posts directly in the Bitbucket UI. At this point, you can now create and edit blog posts directly in the Bitbucket UI.
![][2] ![Bitbucket blog Screenshot][2]
[2]: /images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-blog-post.png [2]: /images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-blog-post.png
## Suggested next steps ## Suggested next steps
The code for this example can be found in this Bitbucket [repository](https://bitbucket.org/dundonian/hugo-docs-test). Aerobatic also provides a number of additional [plugins](https://www.aerobatic.com/docs) such as auth and redirects that you can use for your Hugo site. The code for this example can be found in this Bitbucket [repository](https://bitbucket.org/dundonian/hugo-docs-test). Aerobatic also provides a number of additional [plugins](https://www.aerobatic.com/docs) such as auth and redirects that you can use for your Hugo site.
@@ -89,6 +89,6 @@ git push -u origin master
You can watch the progress and CI job output in your Gitlab project under “Pipelines”. You can watch the progress and CI job output in your Gitlab project under “Pipelines”.
After verifying your CI job ran without issues, first check that your GitLab page shows up under `https://youruser.gitlab.io/reponame/` (it might look broken depending on your browser settings as all links point to your KeyCDN zone – don’t worry about that) and then by heading to whatever Zonealias / Zone URL you defined. After verifying your CI job ran without issues, first check that your GitLab page shows up under `https://youruser.gitlab.io/reponame/` (it might look broken depending on your browser settings as all links point to your KeyCDN zone – don’t worry about that) and then by heading to whatever Zone alias / Zone URL you defined.
To learn more about Hugo hosting options with KeyCDN, check out the complete [Hugo hosting with KeyCDN integration guide](https://www.keycdn.com/support/hugo-hosting/). To learn more about Hugo hosting options with KeyCDN, check out the complete [Hugo hosting with KeyCDN integration guide](https://www.keycdn.com/support/hugo-hosting/).