Skip to content

Commit 01d4135

Browse files
aparajitaulivz
authored andcommitted
docs: fixes theme config grammar (#755)
1 parent ac85a29 commit 01d4135

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/default-theme-config/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ You can omit the `.md` extension, and paths ending with `/` are inferred as `*/R
136136

137137
The sidebar automatically displays links for headers in the current active page, nested under the link for the page itself. You can customize this behavior using `themeConfig.sidebarDepth`. The default depth is `1`, which extracts the `h2` headers. Setting it to `0` disables the header links, and the max value is `2` which extracts both `h2` and `h3` headers.
138138

139-
A page can also override this value in using `YAML front matter`:
139+
A page can also override this value via `YAML front matter`:
140140

141141
``` md
142142
---
@@ -302,7 +302,7 @@ sidebar: false
302302

303303
### Built-in Search
304304

305-
You can disable the built-in search box with `themeConfig.search: false`, and customize how many suggestions to be shown with `themeConfig.searchMaxSuggestions`:
305+
You can disable the built-in search box with `themeConfig.search: false`, and customize how many suggestions will be shown with `themeConfig.searchMaxSuggestions`:
306306

307307
``` js
308308
module.exports = {
@@ -340,7 +340,7 @@ For more options, refer to [Algolia DocSearch's documentation](https://github.co
340340

341341
## Last Updated
342342

343-
The `themeConfig.lastUpdated` option allows you to get the UNIX timestamp(ms) of each file's last `git` commit, and it will also display at the bottom of each page with a appropriate format:
343+
The `themeConfig.lastUpdated` option allows you to get the UNIX timestamp(ms) of each file's last `git` commit, and it will also display at the bottom of each page in an appropriate format:
344344

345345
``` js
346346
module.exports = {
@@ -350,10 +350,10 @@ module.exports = {
350350
}
351351
```
352352

353-
Note that it's `off` by default. If given `string`, it will be displayed as a prefix (default value: `Last Updated`).
353+
Note that it's `off` by default. If given a `string`, it will be displayed as a prefix (default value: `Last Updated`).
354354

355355
::: warning
356-
Since `lastUpdated` is based on `git`, you can only use it in a `git` repository. As well, since the timestamp used comes from the git commit, it will display only after a first commit for a given page, and update only on subsequent commits of that page.
356+
Since `lastUpdated` is based on `git`, you can only use it in a `git` repository. Also, since the timestamp used comes from the git commit, it will display only after a first commit for a given page, and update only on subsequent commits of that page.
357357
:::
358358

359359
## Service Worker

0 commit comments

Comments
 (0)