Features

      Contents

      General

      I am not the best webmaster, but should be somewhat responsive. I intentionally using the bigger fonts to make, feel free to change it in main.css

      Light mode

      Now light mode also supported.

      Important

      Please make sure to set up your base_url with trailing slash:

      base_url = "https://kuznetsov17.github.io/minimal-dark/"
      

      Comments

      Theme supports Giscuss for comments. The configuration is done via config.toml. Here you can see the example section used for this page deployment:

      [extra.giscus]
      data_repo="kuznetsov17/minimal-dark"
      data_repo_id="R_kgDOLIfXYA"
      data_category="General"
      data_category_id="DIC_kwDOLIfXYM4Ccn56"
      data_mapping="title"
      data_strict="0"
      data_reactions_enabled="0"
      data_emit_metadata="0"
      data_input_position="top"
      data_theme="//kuznetsov17.github.io/minimal-dark/css/gs_dark.css"
      data_lang="en"
      crossorigin="anonymous"
      nonce=""
      

      Page configurations

      Customize the page blocks by setting configuration in [extra] section:

      show_copyright = true / false # enables / disables footer with copyright
      show_comments = true / false # enables / disables comments
      show_shares = true / false # enables / disables section with social share buttons
      show_toc = true / false # enables / disable TOC
      show_date = true / false # displays publication date in page
      

      Blog

      I am using this theme for my notes, or probably blog. The section template supports pagination, tags, sorts the pages by publication date. You may see the working example here

      Search

      The theme supports the search using elasticrunrjs. To enable the search, you will need the following configuration in config.toml:

      build_search_index = true
      
      [search]
      index_format = "elasticlunr_json"
      

      config.toml extras

      author = "John Doe" # author. Will be puth in page metadata
      description = "Some description, if you somehow didn't set it in page / section settings"
      logo_src = "images/logo.svg" # logo src
      avatar_src = "images/avatar.png" # avatar src
      index_page="index" # name of the index page. Should be one of top_menu to make things work
      top_menu = ["index","features","notes"] # Menu items
      copyright_string = "Сreated by John Doe in 2024 – %YEAR% for fun." # footer content. %YEAR% will be replaced with current year
      nonce = "${SOME_HASH_VALUE}" # used for JavaScript src nonce
      

      timeline

      • Lorem Ipsum Event

        Lorem Ipsum is simply dummy text of the printing and typesetting industry.

      • Lorem Ipsum event 2

        Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.

      Callouts

      This is an example of Warning callout. Some link

      This is an example of Alert callout. Some link

      This is an example of Info callout. Some link

      Mermaid

      Read more on how to use mermaid in their documentation

      gitGraph
             commit
             commit
             branch develop
             checkout develop
             commit
             commit
             checkout main
             merge develop
             commit
             commit
      
      graph LR
          A[Square Rect] -- Link text --> B((Circle))
          A --> C(Round Rect)
          B --> D{Rhombus}
          C --> D