2021-02-22 03:18:17 +00:00
< p align = "center" >
< a href = "https://github.com/RatanShreshtha/DeepThought" >
< img src = "static/images/avatar.png" alt = "Logo" width = "80" height = "80" >
< / a >
< h3 align = "center" > DeepThought< / h3 >
< p align = "center" >
A simple blog theme focused on writing powered by Bulma and Zola.
< br / >
< a href = "https://deepthought-theme.netlify.app/docs/" > < strong > Explore the docs »< / strong > < / a >
< br / >
< br / >
< a href = "https://github.com/RatanShreshtha/DeepThought" > Code Repository< / a >
·
< a href = "https://github.com/RatanShreshtha/DeepThought/issues" > Report Bug< / a >
·
< a href = "https://github.com/RatanShreshtha/DeepThought/issues" > Request Feature< / a >
< / p >
< / p >
< details open = "open" >
< summary > < h2 style = "display: inline-block" > Table of Contents< / h2 > < / summary >
< ol >
< li >
< a href = "#about-the-project" > About The Project< / a >
< ul >
< li > < a href = "#built-with" > Built With< / a > < / li >
< / ul >
< / li >
< li >
< a href = "#getting-started" > Getting Started< / a >
< ul >
< li > < a href = "#prerequisites" > Prerequisites< / a > < / li >
< li > < a href = "#installation" > Installation< / a > < / li >
< / ul >
< / li >
< li > < a href = "#usage" > Usage< / a > < / li >
< li > < a href = "#roadmap" > Roadmap< / a > < / li >
< li > < a href = "#contributing" > Contributing< / a > < / li >
< li > < a href = "#license" > License< / a > < / li >
< li > < a href = "#contact" > Contact< / a > < / li >
< li > < a href = "#acknowledgements" > Acknowledgements< / a > < / li >
< / ol >
< / details >
## About The Project
[![DeepThought ](./screenshot.png )](https://deepthought-theme.netlify.app/)
> A simple blog theme focused on writing powered by Bulma and Zola.
### Features
- [x] Dark Mode
- [x] Pagination
- [x] Search
- [x] Charts
- [x] Maps
- [x] Diagrams
- [x] Galleria
- [x] Analytics
- [x] Comments
- [x] Categories
- [x] Social Links
2021-03-13 07:55:28 +00:00
- [x] Multilingual Navbar
- [x] Katex
2021-02-22 03:18:17 +00:00
### Built With
* [Zola ](https://www.getzola.org/ )
* [Bulma ](https://bulma.io/ )
2020-09-01 20:35:04 +00:00
2021-02-22 03:18:17 +00:00
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
You need static site generator (SSG) [Zola ](https://www.getzola.org/documentation/getting-started/installation/ ) installed in your machine to use this theme follow their guide on [getting started ](https://www.getzola.org/documentation/getting-started/overview/ ).
### Installation
Follow zola's guide on [installing a theme ](https://www.getzola.org/documentation/themes/installing-and-using-themes/ ).
2020-09-01 23:07:30 +00:00
Make sure to add `theme = "DeepThought"` to your `config.toml`
2020-09-01 20:35:04 +00:00
2020-09-27 08:40:17 +00:00
**Check zola version (only 0.9.0+)**
2020-09-01 20:35:04 +00:00
Just to double-check to make sure you have the right version. It is not supported to use this theme with a version under 0.9.0.
2021-02-22 03:18:17 +00:00
## Usage
### How to serve?
Go into your sites directory and type `zola serve` . You should see your new site at `localhost:1111` .
2020-09-01 20:35:04 +00:00
2020-12-27 10:35:28 +00:00
**NOTE** : you must provide the theme options variables in `config.toml` to serve a functioning site
2021-02-22 03:18:17 +00:00
### Deployment
2020-09-01 20:35:04 +00:00
[Zola ](https://www.getzola.org ) already has great documentation for deploying to [Netlify ](https://www.getzola.org/documentation/deployment/netlify/ ) or [Github Pages ](https://www.getzola.org/documentation/deployment/github-pages/ ). I won't bore you with a regurgitated explanation.
2021-02-22 03:18:17 +00:00
### Theme Options
2020-09-01 20:35:04 +00:00
```toml
2020-12-27 10:35:28 +00:00
navbar_items = [
2021-07-09 15:30:15 +00:00
{ code = "en", nav_items = [
{ url = "$BASE_URL/", name = "Home" },
{ url = "$BASE_URL/posts", name = "Posts" },
{ url = "$BASE_URL/docs", name = "Docs" },
{ url = "$BASE_URL/tags", name = "Tags" },
{ url = "$BASE_URL/categories", name = "Categories" },
]},
2020-12-27 10:35:28 +00:00
]
2020-09-27 08:40:17 +00:00
# Add links to favicon, you can use https://realfavicongenerator.net/ to generate favicon for your site
2020-09-01 20:35:04 +00:00
[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"
# Author details
[extra.author]
2020-09-01 23:07:30 +00:00
name = "DeepThought"
2020-09-01 20:35:04 +00:00
avatar = "/images/avatar.png"
2020-09-27 08:40:17 +00:00
# Social links
2020-09-01 20:35:04 +00:00
[extra.social]
2021-02-22 03:18:17 +00:00
email = "< email_id > "
2020-09-01 20:35:04 +00:00
facebook = "< facebook_username > "
github = "< github_username > "
2021-01-19 18:02:26 +00:00
gitlab = "< gitlab_username > "
2020-09-01 20:35:04 +00:00
keybase = "< keybase_username > "
linkedin = "< linkedin_username > "
stackoverflow = "< stackoverflow_userid > "
twitter = "< twitter_username > "
2021-07-09 17:13:34 +00:00
instagram = "< instagram_usernaem > "
behance = "< behance_username > "
2020-09-01 20:35:04 +00:00
2021-02-22 03:18:17 +00:00
2020-09-01 20:35:04 +00:00
# To add google analytics
[extra.analytics]
google = "< your_gtag > "
2021-03-13 08:54:49 +00:00
# To add disqus comments
2020-09-01 20:35:04 +00:00
[extra.commenting]
2021-03-19 18:49:57 +00:00
disqus = "< your_disqus_shortname > "
2020-09-01 20:35:04 +00:00
2020-09-01 20:51:09 +00:00
# To enable mapbox maps
2020-09-01 20:35:04 +00:00
[extra.mapbox]
access_token = "< your_access_token > "
```
2021-03-13 07:55:28 +00:00
#### Multilingual Navbar
2021-02-22 03:18:17 +00:00
2021-03-13 07:55:28 +00:00
If you want to have a multilingual navbar on your blog, you must add your new code language in the [languages ](https://www.getzola.org/documentation/content/multilingual/#configuration ) array in the `config.toml` file.
**NOTE**: Don't add you default language to this array
```toml
languages = [
{code = "fr"},
{code = "es"},
]
```
And then create and array of nav item for each language:
**NOTE**: Include your default language in this array
```toml
navbar_items = [
{ code = "en", nav_items = [
{ url = "$BASE_URL/", name = "Home" },
{ url = "$BASE_URL/posts", name = "Posts" },
{ url = "$BASE_URL/docs", name = "Docs" },
{ url = "$BASE_URL/tags", name = "Tags" },
{ url = "$BASE_URL/categories", name = "Categories" },
]},
{ code = "fr", nav_items = [
{ url = "$BASE_URL/", name = "Connexion" },
]},
{ code = "es", nav_items = [
{ url = "$BASE_URL/", name = "Publicationes" },
{ url = "$BASE_URL/", name = "Registrar" },
]}
]
2021-02-21 00:30:27 +00:00
```
2021-03-13 07:55:28 +00:00
en:
![DeepThought ](./screenshot_navbar_en.png )
fr:
![DeepThought ](./screenshot_navbar_fr.png )
es:
![DeepThought ](./screenshot_navbar_es.png )
2021-02-21 00:30:27 +00:00
### KaTeX math formula support
This theme contains math formula support using [KaTeX ](https://katex.org/ ),
which can be enabled by setting `katex.enabled = true` in the `extra` section
+of `config.toml` :
```toml
[extra]
katex.enabled = true
katex.auto_render = true
```
After enabling this extension, the `katex` short code can be used in documents:
* `{{ katex(body="\KaTeX") }}` to typeset a math formula inlined into a text,
similar to `$...$` in LaTeX
* `{% katex(block=true) %}\KaTeX{% end %}` to typeset a block of math formulas,
similar to `$$...$$` in LaTeX
#### Automatic rendering without short codes
Optionally, `\\( \KaTeX \\)` / `$ \KaTeX $` inline and `\\[ \KaTeX \\]` / `$$ \KaTeX $$`
block-style automatic rendering is also supported, if enabled in the config:
```toml
[extra]
katex.enabled = true
katex.auto_render = true
2020-09-01 20:35:04 +00:00
```
2021-02-22 03:18:17 +00:00
## Roadmap
See the [open issues ](https://github.com/RatanShreshtha/DeepThought/issues ) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated** .
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Ratan Kulshreshtha - [@RatanShreshtha ](https://twitter.com/RatanShreshtha )>
Project Link: [https://github.com/RatanShreshtha/DeepThought ](https://github.com/RatanShreshtha/DeepThought )
## Acknowledgements
* [GitHub Emoji Cheat Sheet ](https://www.webpagefx.com/tools/emoji-cheat-sheet )
* [Choose an Open Source License ](https://choosealicense.com )
* [Slick Carousel ](https://kenwheeler.github.io/slick )
* [Font Awesome ](https://fontawesome.com )
2021-03-13 07:55:28 +00:00
* [Unsplash ](https://unsplash.com/ )