Skip to content

Commit

Permalink
Update user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
yash-chowdhary committed Mar 2, 2020
1 parent c4d1cbf commit b626b64
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
8 changes: 8 additions & 0 deletions docs/userGuide/siteConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,3 +198,11 @@ The example above uses tags as an example of configuring plugin settings, refer
#### **`enableSearch`**

**Specifies that the website should use MarkBind's search functionality.** Default: `true`. See [User Guide: Making the Site Searchable](makingTheSiteSearchable.html) for more details.

#### **`timeZone`**

**Time zone of the time stamp that indicates when the page was generated.** Default: `"UTC"`. See [User Guide: Built-in Variable: `timestamp`](reusingContents.html#built-in-variable-timestamp) for more details.

#### **`locale`**

**Language by locale used for the time stamp.** Default: `"en-GB"`. The date format is thus - <br> `<Day>, <Date> <Month> <Year>, <24-hour Time> <Time Zone Code>`. See [User Guide: Built-in Variable: `timestamp`](reusingContents.html#built-in-variable-timestamp) for more details.
14 changes: 2 additions & 12 deletions docs/userGuide/syntax/variables.mbdf
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,9 @@ Represents the root directory of the project. Used for specifying intra-site lin

<code>{<span></span>{ timestamp }}</code> is the time stamp that indicates when the page was generated.

You can set the time zone and locale in `site.json` like so -

```js
site.json
{
...
"timeZone": "Asia/Singapore",
"locale": "en-US",
...
}
```
Compiled in the following gists are lists of possible [time zone](https://gist.github.com/yash-chowdhary/136df3f6721f2fd1d5ea46b14f7c531c) and [locale](https://gist.github.com/yash-chowdhary/674654bdd977b063de008c1b3655a515) options.

The default values of `"timeZone"` and `"locale"` are `"UTC"` and `"en-GB"` respectively.
The default values of `"timeZone"` and `"locale"` are `"UTC"` and `"en-GB"` respectively. The following example showcases the use of the `"Asia/Singapore"` time zone.

<div class="indented">

Expand Down

0 comments on commit b626b64

Please sign in to comment.