@@ -131,7 +131,7 @@ hugo new site my-new-blog
131
131
rm my-new-blog/archetypes/default.md
132
132
```
133
133
134
- - Copy the example site content including the ` config.toml ` file:
134
+ - Copy the example site content, including the ` config.toml ` file:
135
135
136
136
``` shell
137
137
cp -r bilberry-hugo-theme/v4/exampleSite/* my-new-blog
@@ -211,7 +211,7 @@ Renaming this folder will break your site.
211
211
212
212
### Configuration
213
213
214
- To customize website according to your needs, edit the ` config.toml ` file in the site's root
214
+ To customize your website according to your needs, edit the ` config.toml ` file in the site's root
215
215
directory by adjusting the settings. All parameters that need to be configured are commented out or
216
216
disabled.
217
217
@@ -309,9 +309,9 @@ To enable and configure search functionality for your site, follow these steps:
309
309
4 . Switch over to ` API Keys ` and copy your ` Application ID ` , ` Search-Only API Key ` and chosen ` Index name ` to
310
310
your ` config.toml ` file.
311
311
5 . Make sure that the ` algolia_search ` parameter is set to ` true ` .
312
- 6 . Follow instructions in the section [ Update Algolia Index] ( #update-algolia-index ) and proceed to the next step.
312
+ 6 . Follow the instructions in the section [ Update Algolia Index] ( #update-algolia-index ) and proceed to the next step.
313
313
7 . To complete the initial setup, go to the tab ` Configuration ` of your newly created indices, select the ` Facets ` in
314
- the section ` FILTERING AND FACETING ` and add the ` language ` attribute with the ` filter only ` modifier in
314
+ the section ` FILTERING AND FACETING ` , and add the ` language ` attribute with the ` filter only ` modifier in
315
315
the ` Attributes for faceting ` option. If, after adding the ` language ` attribute, the ` Unknown attribute ` error is
316
316
shown, ignore it.
317
317
@@ -324,22 +324,22 @@ Execute the `hugo` command in the site's root directory to generate the `index.j
324
324
##### Manual Upload
325
325
326
326
1 . Head over to the ` public/index.json ` file and copy its content.
327
- 2 . Login to your Algolia account, open your index and click at ` Add records manually ` .
327
+ 2 . Log in to your Algolia account, open your index, and click on ` Add records manually ` .
328
328
3 . Paste the copied text from the ` index.json ` file.
329
329
4 . Verify in the ` Browse ` tab of your index that the index records were uploaded correctly.
330
330
5 . In case you have a multi-language setup, make sure that you repeat the steps above for all ` public/{LANG}/index.json `
331
331
files.
332
332
333
333
##### Automated Upload
334
334
335
- 1 . Switch to the ` algolia ` directory and install required dependencies by executing the following command:
335
+ 1 . Switch to the ` algolia ` directory and install the required dependencies by executing the following command:
336
336
337
337
``` shell script
338
338
cd algolia
339
339
npm install
340
340
```
341
341
342
- 2 . Run the ` data-upload.js ` from from the ` algolia ` directory as follows:
342
+ 2 . Run the ` data-upload.js ` from the ` algolia ` directory as follows:
343
343
344
344
``` shell script
345
345
npm run data-upload -- -f ../public/index.json -a < algolia-app-id> -k < algolia-admin-api-key> -n < algolia-index-name>
@@ -349,7 +349,7 @@ Execute the `hugo` command in the site's root directory to generate the `index.j
349
349
delete indices, and it should be kept secret.
350
350
4 . Add the ` -c ` or ` --clear-index ` option if you want to clear the corresponding Algolia index before starting a new
351
351
upload.
352
- 5 . Login to your Algolia account and verify in the ` Browse ` tab of your index that the index records were uploaded
352
+ 5 . Log in to your Algolia account and verify in the ` Browse ` tab of your index that the index records were uploaded
353
353
correctly.
354
354
6 . In case you have a multi-language setup, make sure that you repeat the steps above for all ` public/{LANG}/index.json `
355
355
files.
@@ -362,7 +362,7 @@ Actions.
362
362
363
363
### Keyboard Shortcuts
364
364
365
- Type ` s ` to open the navigation bar and set focus to the search input field.
365
+ Type ` s ` to open the navigation bar and set the focus to the search input field.
366
366
To remove focus, press the ` Esc ` key.
367
367
368
368
### Reposted Article/Duplicated Content
@@ -378,7 +378,7 @@ original_url: "https://example.org/path/to/content"
378
378
### Estimated Reading Time
379
379
380
380
To show an article's estimated reading time, set the ` showReadingTime ` parameter to ` true ` in the ` config.toml ` file.
381
- You can override the estimated reading time by setting article's ` readingTime ` front matter variable to a value you
381
+ You can override the estimated reading time by setting the article's ` readingTime ` front matter variable to a value you
382
382
want. If you set this variable to ` 0 ` , the reading time will not be shown.
383
383
384
384
```
@@ -393,7 +393,7 @@ views, such as a home page and tags or categories pages.
393
393
394
394
#### Automatic Summary Split
395
395
396
- Using first 70 words of your content, Hugo automatically generates the summary followed by the _ Continue reading_ link.
396
+ Using the first 70 words of your content, Hugo automatically generates the summary followed by the _ Continue reading_ link.
397
397
398
398
#### Manual Summary Split
399
399
@@ -490,7 +490,7 @@ gallery: [
490
490
491
491
### Image Modal Zoom
492
492
493
- When you include an image that is larger than the content area, the image becomes interactive and a larger version can
493
+ When you include an image that is larger than the content area, the image becomes interactive, and a larger version can
494
494
be opened in a lightbox.
495
495
496
496
### Featured Image
@@ -547,7 +547,7 @@ mp4video: "<video-file-url>" # location of video file (only mp4)
547
547
mp4videoImage: "<image-video-file-url>" # location of poster image
548
548
```
549
549
550
- For example, if an ` MP4 ` video and its image are stored in the ` static ` folder, you can set corresponding front matter
550
+ For example, if an ` MP4 ` video and its image are stored in the ` static ` folder, you can set the corresponding front matter
551
551
variables as follows:
552
552
553
553
``` markdown
@@ -686,10 +686,10 @@ Then uncomment the `commentoJsURL` parameter in the `config.toml` file:
686
686
``` toml
687
687
# [...]
688
688
[params ]
689
- # [...]
689
+ # [...]
690
690
691
- # Commento
692
- commentoJsURL = " http://localhost:8080/js/commento.js"
691
+ # Commento
692
+ commentoJsURL = " http://localhost:8080/js/commento.js"
693
693
```
694
694
695
695
#### Disqus
@@ -700,10 +700,10 @@ Then create a new site and set the `disqusShortname` parameter to your site's sh
700
700
``` toml
701
701
# [...]
702
702
[params ]
703
- # [...]
703
+ # [...]
704
704
705
- # Disqus
706
- disqusShortname = " lednerb"
705
+ # Disqus
706
+ disqusShortname = " lednerb"
707
707
```
708
708
709
709
You can manage and moderate the comments either on your website or using the Disqus management panel.
@@ -718,21 +718,21 @@ Then, in the `config.toml` file, set the `giscus` parameter to `true` and the pr
718
718
``` toml
719
719
# [...]
720
720
[params ]
721
- # [...]
722
-
723
- # Giscus
724
- giscus = true
725
- giscusJsUrl = " https://giscus.app/client.js"
726
- giscusRepository = " Lednerb/bilberry-hugo-theme"
727
- giscusRepositoryId = " R_kgDOGX153A" # generated by Giscus website
728
- giscusMapping = " pathname"
729
- giscusCategory = " General"
730
- giscusCategoryId = " DIC_kwDOGX153M4B_2Vz" # generated by Giscus website
731
- giscusTheme = " light"
732
- giscusReactions = " 1"
733
- giscusEmitMetadata = " 0"
734
- giscusLanguage = " en"
735
- giscusCrossOrigin = " anonymous"
721
+ # [...]
722
+
723
+ # Giscus
724
+ giscus = true
725
+ giscusJsUrl = " https://giscus.app/client.js"
726
+ giscusRepository = " Lednerb/bilberry-hugo-theme"
727
+ giscusRepositoryId = " R_kgDOGX153A" # generated by Giscus website
728
+ giscusMapping = " pathname"
729
+ giscusCategory = " General"
730
+ giscusCategoryId = " DIC_kwDOGX153M4B_2Vz" # generated by Giscus website
731
+ giscusTheme = " light"
732
+ giscusReactions = " 1"
733
+ giscusEmitMetadata = " 0"
734
+ giscusLanguage = " en"
735
+ giscusCrossOrigin = " anonymous"
736
736
```
737
737
738
738
#### Utterances
@@ -744,22 +744,22 @@ the `config.toml` file:
744
744
``` toml
745
745
# [...]
746
746
[params ]
747
- # [...]
747
+ # [...]
748
748
749
- # Utterances
750
- utterances = true
751
- utterancesJsUrl = " https://utteranc.es/client.js"
752
- utterancesRepository = " Lednerb/bilberry-hugo-theme"
753
- utterancesIssueTerm = " pathname"
754
- utterancesLabel = " Comment"
755
- utterancesTheme = " github-light"
756
- utterancesCrossOrigin = " anonymous"
749
+ # Utterances
750
+ utterances = true
751
+ utterancesJsUrl = " https://utteranc.es/client.js"
752
+ utterancesRepository = " Lednerb/bilberry-hugo-theme"
753
+ utterancesIssueTerm = " pathname"
754
+ utterancesLabel = " Comment"
755
+ utterancesTheme = " github-light"
756
+ utterancesCrossOrigin = " anonymous"
757
757
```
758
758
759
759
### Archive Page
760
760
761
761
The archive page will be available at ` <site-base-url>/archive/ ` as soon as you copy
762
- the ` themes/bilberry-hugo-theme/exampleSite/content/archive.md ` file to ` content ` directory of your
762
+ the ` themes/bilberry-hugo-theme/exampleSite/content/archive.md ` file to the ` content ` directory of your
763
763
site. By default, the published content is grouped by year. To group the content by year and month,
764
764
set the ` archiveDateGrouping ` parameter to the ` 2006-01 ` value.
765
765
@@ -849,7 +849,7 @@ site's `layouts/404.html` and edit the file according to your needs, for example
849
849
850
850
### Custom Post Types
851
851
852
- With Bilberry theme, you can create new post types easily.
852
+ With the Bilberry theme, you can create new post types easily.
853
853
For example, suppose you want to create a new type named ` book ` .
854
854
Then you should do the following:
855
855
@@ -898,11 +898,11 @@ Syntax highlighting for code blocks in your posts is implemented using Hugo's
898
898
built-in [Chrome](https://github.com/alecthomas/chroma) code highlighter. Highlighting for code blocks in your posts can
899
899
be customized at the site level or per code block.
900
900
901
- To change the default configuration at the site level, adjust the properties in the `[markup.highlight]` section of
901
+ To change the default configuration at the site level, adjust the properties in the `[markup.highlight]` section of
902
902
the `config.toml` file. For example, you can change the default `monokai` style to the one from
903
903
the [Chroma Style Gallery](https://xyproto.github.io/splash/docs/all.html).
904
904
905
- Per code block, the following parameters can be
905
+ Per the code block, the following parameters can be
906
906
personalized: `linenos`, `hl_lines`, `linenostart`, `anchorlinenos`, `lineanchors`, and `hl_inline`, for example:
907
907
908
908
\```java {linenos=inline, hl_lines="7-12 21-26"}
@@ -915,8 +915,7 @@ Read Hugo's [documentation](https://gohugo.io/content-management/syntax-highligh
915
915
916
916
# ## Colors and Fonts
917
917
918
- Styling is implemented using SCSS along with [npm](https://www.npmjs.com/), which is only used for the development
919
- dependency management. Colors and fonts can be customized via variables defined in
918
+ Styling is implemented using SCSS along with [npm](https://www.npmjs.com/), which is only used for dependency management. Colors and fonts can be customized via variables defined in
920
919
the [` assets/sass/theme.scss` ](v4/assets/sass/theme.scss) file.
921
920
922
921
For example, if you want to customize the ` $base -color` variable, you should define the ` baseColor` parameter in your
@@ -935,7 +934,7 @@ $base-color: {{ .Param "baseColor" | default "#1d1f38" }};
935
934
936
935
This theme supports hot-swappable CSS and JavaScript extensions, which can be specified using the `css_modules`
937
936
and `js_modules` list parameters in your site' s ` config.toml` file. Modules can be specified either relative to the ` static`
938
- directory (e.g. ` exampleSite/static/css/custom.css` ) or as a URL.
937
+ directory (e.g., ` exampleSite/static/css/custom.css` ) or as a URL.
939
938
940
939
Modules are imported in the order they appear in the list, and immediately after the default Bilberry CSS and JS files
941
940
are imported.
@@ -977,14 +976,14 @@ js_modules = ["..", "//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cooki
977
976
978
977
## Translations
979
978
980
- Bilberry theme has built-in support for multi-language sites, and currently supports translations for more than 20
979
+ Bilberry theme has built-in support for multi-language sites and currently supports translations for more than 20
981
980
languages.
982
981
983
982
Feel free to submit a request for a new language translation or improve existing ones!
984
983
985
984
## Credits
986
985
987
- Bilberry theme was inspired by the [WordPress theme Lingonberry](https://en-ca.wordpress.org/themes/lingonberry/)
986
+ The Bilberry theme was inspired by the [WordPress theme Lingonberry](https://en-ca.wordpress.org/themes/lingonberry/)
988
987
created by Anders Norén.
989
988
990
989
Bilberry is a theme for the great [HUGO static site generator](https://gohugo.io).
0 commit comments