From ec0d79258d2cd04d0e5143ecf7ea40a7aaa49b7a Mon Sep 17 00:00:00 2001 From: Aparajita Fishman Date: Tue, 21 Aug 2018 15:55:02 -0400 Subject: [PATCH] Theme config grammar fixes --- docs/default-theme-config/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/default-theme-config/README.md b/docs/default-theme-config/README.md index 2553476644..298016b5ad 100644 --- a/docs/default-theme-config/README.md +++ b/docs/default-theme-config/README.md @@ -136,7 +136,7 @@ You can omit the `.md` extension, and paths ending with `/` are inferred as `*/R 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. -A page can also override this value in using `YAML front matter`: +A page can also override this value via `YAML front matter`: ``` md --- @@ -302,7 +302,7 @@ sidebar: false ### Built-in Search -You can disable the built-in search box with `themeConfig.search: false`, and customize how many suggestions to be shown with `themeConfig.searchMaxSuggestions`: +You can disable the built-in search box with `themeConfig.search: false`, and customize how many suggestions will be shown with `themeConfig.searchMaxSuggestions`: ``` js module.exports = { @@ -340,7 +340,7 @@ For more options, refer to [Algolia DocSearch's documentation](https://github.co ## Last Updated -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: +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: ``` js module.exports = { @@ -350,10 +350,10 @@ module.exports = { } ``` -Note that it's `off` by default. If given `string`, it will be displayed as a prefix (default value: `Last Updated`). +Note that it's `off` by default. If given a `string`, it will be displayed as a prefix (default value: `Last Updated`). ::: warning - 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. + 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. ::: ## Service Worker