Add doc for config options

This commit is contained in:
Ratan Kulshreshtha 2020-09-02 01:43:18 +05:30
parent 873498139c
commit ecc974a07f
5 changed files with 118 additions and 17 deletions

View File

@ -4,15 +4,3 @@ description = "Blog posts accumulated over the time."
sort_by = "date"
paginate_by = 7
+++
Hello posts
<!-- more -->
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore
eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt
in culpa qui officia deserunt mollit anim id est laborum.

View File

@ -1,6 +1,6 @@
+++
title="Basic Markdown Syntax"
date=2019-06-29
date=2020-08-28
[taxonomies]
categories = ["Markdown"]

View File

@ -0,0 +1,112 @@
+++
title = "Config Options"
description = "Few config options provides by Deep Thought theme."
date = 2020-08-30
[taxonomies]
categories = ["Documentation"]
tags = ["theme", "zola"]
[extra]
toc = true
comment = true
+++
Deep Thought theme provides some config option like option to add favicon to your site, add avatar for profile, setup social links for the profile etc
<!-- more -->
## Author Details
You can configure author details in `[extra.author]` of `config.toml` file.
```toml
[extra.author]
name = "<your_name>"
avatar = "<path_to_avatar>"
```
# Site Configurations
## Favicon Setup
You can configure favicon in `[extra.favicon]` of `config.toml` file. You can use something like [realfavicongenerator](https://realfavicongenerator.net/) to generate your favicon.
```toml
[extra.favicon]
favicon_16x16 = "/icons/favicon-16x16.png"
favicon_32x32 = "/icons/favicon-32x32.png"
apple_touch_icon = "/icons/apple-touch-icon.png"
safari_pinned_tab = "/icons/safari-pinned-tab.svg"
webmanifest = "/icons/site.webmanifest"
```
## Social Link Setup
You can configure social links in `[extra.social]` of `config.toml` file.
```toml
[extra.social]
facebook = "<facebook_username>"
github = "<github_username>"
keybase = "<keybase_username>"
linkedin = "<linkedin_username>"
stackoverflow = "<stackoverflow_userid>"
twitter = "<twitter_username>"
```
## Google Analytics Setup
**Deep Thought** support google analytics out of the box. You can configure favicon in `[extra.analytics]` of `config.toml` file.
```toml
[extra.analytics]
google = "<your_gtag>"
```
## Hyvor Comments Setup
**Deep Thought** support hyvor commenting out of the box. You can configure favicon in `[extra.commenting]` of `config.toml` file.
```toml
[extra.commenting]
hyvor = "<your_website_id>"
```
## Mapbox Setup
**Deep Thought** support mapbox out of the box to add maps in your posts. You can configure favicon in `[extra.mapbox]` of `config.toml` file.
```toml
[extra.mapbox]
access_token = "<your_access_token>"
```
# Section Configurations
Apart from standard config you can also add a `description` in your `_index.md` file for your sections that appears in listing.
```toml
description = "Blog posts accumulated over the time."
```
# Page Configurations
## Enable Table Of Content
In order to enable `toc` for your post change as below code snippet in your page.
```toml
[extra]
toc = true
```
## Enable Comments
In order to enable `comments` for your post change as below code snippet in your page.
```toml
[extra]
comments = true
```

View File

@ -1,7 +1,7 @@
+++
title = "Extended Shortcodes"
description = "Few more shortcodes provided by deep-thought."
date = 2020-08-30
description = "Few more shortcodes provided by Deep Thought."
date = 2020-08-29
[taxonomies]
categories = ["Documentation"]
@ -9,9 +9,10 @@ tags = ["theme", "zola"]
[extra]
toc = true
comment = true
+++
deep-thought theme provides multiple shortcodes on top of built-in ones in Zola.
Deep Thought theme provides multiple shortcodes on top of built-in ones in Zola.
<!-- more -->

View File

@ -7,7 +7,7 @@ categories = ["Documentation"]
tags = ["theme", "zola"]
+++
This is a small example post of stuff you can do with the `deep-thought` theme.
This is a small example post of stuff you can do with the `Deep Thought` theme.
We'll try to represent all possible markdown and shortcode combinations here
so you can develop easily.