Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ratanshreshtha/deepthought

A simple blog theme focused on writing powered by Bulma and Zola.
https://github.com/ratanshreshtha/deepthought

blog-theme bulma hacktoberfest hactoberfest2022 netlify theme zola

Last synced: 1 day ago
JSON representation

A simple blog theme focused on writing powered by Bulma and Zola.

Awesome Lists containing this project

README 

        



  logo

  
DeepThought


  

  


    A simple blog theme focused on writing powered by Bulma and Zola.

  


  

  





  

    contributors

  

  

    last update

  

  

    forks

  

  

    stars

  

  

    open issues

  

  

    license

  



   



    View Demo

   · 

    Documentation

   · 

    Report Bug

   · 

    Request Feature

  









# :notebook_with_decorative_cover: Table of Contents



- [:notebook_with_decorative_cover: Table of Contents](#notebook_with_decorative_cover-table-of-contents)

  - [:star2: About the Project](#star2-about-the-project)

    - [:camera: Screenshots](#camera-screenshots)

    - [:space_invader: Tech Stack](#space_invader-tech-stack)

    - [:dart: Features](#dart-features)

  - [:toolbox: Getting Started](#toolbox-getting-started)

    - [:bangbang: Prerequisites](#bangbang-prerequisites)

    - [:gear: Installation](#gear-installation)

    - [:running: Run Locally](#running-run-locally)

    - [:triangular_flag_on_post: Deployment](#triangular_flag_on_post-deployment)

  - [:eyes: Usage](#eyes-usage)

      - [Multilingual Navbar](#multilingual-navbar)

    - [KaTeX math formula support](#katex-math-formula-support)

      - [Automatic rendering without short codes](#automatic-rendering-without-short-codes)

    - [Elasticlunr search in other language](#elasticlunr-search-in-other-language)

  - [:wave: Contributing](#wave-contributing)

  - [:warning: License](#warning-license)

  - [:handshake: Contact](#handshake-contact)

  - [:gem: Acknowledgements](#gem-acknowledgements)



  



## :star2: About the Project



### :camera: Screenshots



 

  screenshot




### :space_invader: Tech Stack



- [Zola](https://www.getzola.org/) - Your one-stop static site engine

- [Bulma](https://bulma.io/) - The modern CSS framework that just works. 



### :dart: 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

- [x] Multilingual Navbar

- [x] Katex



## 	:toolbox: Getting Started



### :bangbang: 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/).



### :gear: Installation



Follow zola's guide on [installing a theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/).

Make sure to add `theme = "DeepThought"` to your `config.toml`



**Check zola version (only 0.9.0+)**

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.14.1.



### :running: Run Locally



Go into your sites directory and type `zola serve`. You should see your new site at `localhost:1111`.



**NOTE**: you must provide the theme options variables in `config.toml` to serve a functioning site



### :triangular_flag_on_post: Deployment



[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.



## :eyes: Usage



Following options are available with the `DeepThought` theme



```toml

# Enable external libraries

[extra]

katex.enabled = true

katex.auto_render = true



chart.enabled = true

mermaid.enabled = true

galleria.enabled = true



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" },

 ]},

]



# Add links to favicon, you can use https://realfavicongenerator.net/ to generate favicon for your site

[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]

name = "DeepThought"

avatar = "/images/avatar.png"



# Social links

[extra.social]

email = ""

facebook = ""

github = ""

gitlab = ""

keybase = ""

linkedin = ""

stackoverflow = ""

twitter = ""

instagram = ""

behance = ""

google_scholar = ""

orcid = ""

mastodon_username = ""

mastodon_server = "" (if not set, defaults to mastodon.social)



# To add google analytics

[extra.analytics]

google = ""



# To add disqus comments

[extra.commenting]

disqus = ""



# To enable mapbox maps

[extra.mapbox]

enabled = true

access_token = ""

```



#### Multilingual Navbar



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" },

 ]}

]

```



en:



![DeepThought](./screenshot_navbar_en.png)



fr:



![DeepThought](./screenshot_navbar_fr.png)



es:



![DeepThought](./screenshot_navbar_es.png)



### 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`.



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

by setting `katex.auto_render = true`.



### Elasticlunr search in other language



Zola use [Elasticlunr.js](https://github.com/weixsong/elasticlunr.js) to add full-text search feature.

To use languages other than en (English), you need to add some javascript files. See the Zola's issue [#1349](https://github.com/getzola/zola/issues/1349).

By placing the `templates/base.html`on your project and using the `other_lang_search_js` block, you can load the required additional javascript files in the right timing.



e.g. `templates/base.html`



```html

{% extends "DeepThought/templates/base.html" %} {% block other_lang_search_js %}



{% endblock %}

```



More detailed explanations are aound in [elasticlunr's documents](https://github.com/weixsong/elasticlunr.js#other-languages-example-in-browser).



## :wave: 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.



- Fork the Project

- Create your Feature Branch (git checkout -b feature/AmazingFeature)

- Commit your Changes (git commit -m 'Add some AmazingFeature')

- Push to the Branch (git push origin feature/AmazingFeature)

- Open a Pull Request



## :warning: License



Distributed under the MIT License. See  `LICENSE` for more information.



## :handshake: Contact



Ratan Kulshreshtha - [@RatanShreshtha](https://twitter.com/RatanShreshtha) - ratan.shreshtha[at]gmail.com



Project Link: [https://github.com/RatanShreshtha/DeepThought](https://github.com/RatanShreshtha/DeepThought)



## :gem: Acknowledgements



Use this section to mention useful resources and libraries that you have used in your projects.



- [Shields.io](https://shields.io/)

- [Choose an Open Source License](https://choosealicense.com)

- [Awesome README](https://github.com/matiassingers/awesome-readme)

- [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/main/README.md#travel--places)

- [Slick Carousel](https://kenwheeler.github.io/slick)

- [Font Awesome](https://fontawesome.com)

- [Unsplash](https://unsplash.com/)