Skip to content

Commit 7aefc5b

Browse files
docs(v4): proofread README (#566)
1 parent 1489279 commit 7aefc5b

File tree

1 file changed

+51
-52
lines changed

1 file changed

+51
-52
lines changed

v4-README.md

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ hugo new site my-new-blog
131131
rm my-new-blog/archetypes/default.md
132132
```
133133

134-
- Copy the example site content including the `config.toml` file:
134+
- Copy the example site content, including the `config.toml` file:
135135

136136
```shell
137137
cp -r bilberry-hugo-theme/v4/exampleSite/* my-new-blog
@@ -211,7 +211,7 @@ Renaming this folder will break your site.
211211

212212
### Configuration
213213

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
215215
directory by adjusting the settings. All parameters that need to be configured are commented out or
216216
disabled.
217217

@@ -309,9 +309,9 @@ To enable and configure search functionality for your site, follow these steps:
309309
4. Switch over to `API Keys` and copy your `Application ID`, `Search-Only API Key` and chosen `Index name` to
310310
your `config.toml` file.
311311
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.
313313
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
315315
the `Attributes for faceting` option. If, after adding the `language` attribute, the `Unknown attribute` error is
316316
shown, ignore it.
317317

@@ -324,22 +324,22 @@ Execute the `hugo` command in the site's root directory to generate the `index.j
324324
##### Manual Upload
325325

326326
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`.
328328
3. Paste the copied text from the `index.json` file.
329329
4. Verify in the `Browse` tab of your index that the index records were uploaded correctly.
330330
5. In case you have a multi-language setup, make sure that you repeat the steps above for all `public/{LANG}/index.json`
331331
files.
332332

333333
##### Automated Upload
334334

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:
336336

337337
```shell script
338338
cd algolia
339339
npm install
340340
```
341341

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:
343343

344344
```shell script
345345
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
349349
delete indices, and it should be kept secret.
350350
4. Add the `-c` or `--clear-index` option if you want to clear the corresponding Algolia index before starting a new
351351
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
353353
correctly.
354354
6. In case you have a multi-language setup, make sure that you repeat the steps above for all `public/{LANG}/index.json`
355355
files.
@@ -362,7 +362,7 @@ Actions.
362362

363363
### Keyboard Shortcuts
364364

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.
366366
To remove focus, press the `Esc` key.
367367

368368
### Reposted Article/Duplicated Content
@@ -378,7 +378,7 @@ original_url: "https://example.org/path/to/content"
378378
### Estimated Reading Time
379379

380380
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
382382
want. If you set this variable to `0`, the reading time will not be shown.
383383

384384
```
@@ -393,7 +393,7 @@ views, such as a home page and tags or categories pages.
393393

394394
#### Automatic Summary Split
395395

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.
397397

398398
#### Manual Summary Split
399399

@@ -490,7 +490,7 @@ gallery: [
490490

491491
### Image Modal Zoom
492492

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
494494
be opened in a lightbox.
495495

496496
### Featured Image
@@ -547,7 +547,7 @@ mp4video: "<video-file-url>" # location of video file (only mp4)
547547
mp4videoImage: "<image-video-file-url>" # location of poster image
548548
```
549549

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
551551
variables as follows:
552552

553553
```markdown
@@ -686,10 +686,10 @@ Then uncomment the `commentoJsURL` parameter in the `config.toml` file:
686686
```toml
687687
#[...]
688688
[params]
689-
#[...]
689+
#[...]
690690

691-
# Commento
692-
commentoJsURL = "http://localhost:8080/js/commento.js"
691+
# Commento
692+
commentoJsURL = "http://localhost:8080/js/commento.js"
693693
```
694694

695695
#### Disqus
@@ -700,10 +700,10 @@ Then create a new site and set the `disqusShortname` parameter to your site's sh
700700
```toml
701701
#[...]
702702
[params]
703-
#[...]
703+
#[...]
704704

705-
# Disqus
706-
disqusShortname = "lednerb"
705+
# Disqus
706+
disqusShortname = "lednerb"
707707
```
708708

709709
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
718718
```toml
719719
#[...]
720720
[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"
736736
```
737737

738738
#### Utterances
@@ -744,22 +744,22 @@ the `config.toml` file:
744744
```toml
745745
#[...]
746746
[params]
747-
#[...]
747+
#[...]
748748

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"
757757
```
758758

759759
### Archive Page
760760

761761
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
763763
site. By default, the published content is grouped by year. To group the content by year and month,
764764
set the `archiveDateGrouping` parameter to the `2006-01` value.
765765

@@ -849,7 +849,7 @@ site's `layouts/404.html` and edit the file according to your needs, for example
849849

850850
### Custom Post Types
851851

852-
With Bilberry theme, you can create new post types easily.
852+
With the Bilberry theme, you can create new post types easily.
853853
For example, suppose you want to create a new type named `book`.
854854
Then you should do the following:
855855

@@ -898,11 +898,11 @@ Syntax highlighting for code blocks in your posts is implemented using Hugo's
898898
built-in [Chrome](https://github.com/alecthomas/chroma) code highlighter. Highlighting for code blocks in your posts can
899899
be customized at the site level or per code block.
900900
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
902902
the `config.toml` file. For example, you can change the default `monokai` style to the one from
903903
the [Chroma Style Gallery](https://xyproto.github.io/splash/docs/all.html).
904904
905-
Per code block, the following parameters can be
905+
Per the code block, the following parameters can be
906906
personalized: `linenos`, `hl_lines`, `linenostart`, `anchorlinenos`, `lineanchors`, and `hl_inline`, for example:
907907
908908
\```java {linenos=inline, hl_lines="7-12 21-26"}
@@ -915,8 +915,7 @@ Read Hugo's [documentation](https://gohugo.io/content-management/syntax-highligh
915915

916916
### Colors and Fonts
917917

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
920919
the [`assets/sass/theme.scss`](v4/assets/sass/theme.scss) file.
921920

922921
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" }};
935934
936935
This theme supports hot-swappable CSS and JavaScript extensions, which can be specified using the `css_modules`
937936
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.
939938

940939
Modules are imported in the order they appear in the list, and immediately after the default Bilberry CSS and JS files
941940
are imported.
@@ -977,14 +976,14 @@ js_modules = ["..", "//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cooki
977976
978977
## Translations
979978
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
981980
languages.
982981
983982
Feel free to submit a request for a new language translation or improve existing ones!
984983
985984
## Credits
986985
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/)
988987
created by Anders Norén.
989988
990989
Bilberry is a theme for the great [HUGO static site generator](https://gohugo.io).

0 commit comments

Comments
 (0)