[Template] Update : enabling/disabling comments & easy disabling generating graph

[Mara-Li]

Hello everyone!
Following a request, I little edited the comments system and the graph building.

Enable or disable globally & for each page the comments system

To do that, I updated the overrides/hooks/on_env.py file (because Jinja doesn't work as I want...) and add this function:

def value_in_frontmatter(key, metadata):
    """Check if a key exists in the frontmatter.

    Args:
        key (any): the key to check
        metadata (any): the frontmatter

    Returns:
        bool: true if exists
    """
    if key in metadata:
        return metadata[key]
    else:
        return None

I also, obviously, updated the def on_env() function:

def on_env(env, config, files, **kwargs):
...
    env.filters["value_in_frontmatter"] = value_in_frontmatter
    return env

After that, I updated the file overrides/partials/comments.html like that:

{% set local_comments = "comments" | value_in_frontmatter(page.meta) %}
{% set comments = config.extra["comments"] if local_comments is none else local_comments %}
{% if comments %}
<----- GISCUS BLOCK ----->
{% endif %}

Now, you can play with two things : Your mkdocs.yml (in extra and by each file using the frontmatter. The two use the same comments key.

• If you set the comments: false in your mkdocs.yml, it will disable globally the comments. In this case, if you want to enable the comments, you need to set comments: true in the frontmatter of the choosen file.
• Otherwise, you can enable globally with comments: true and disable for each file using comments: false

Disable graph generator without editing the python file

I can be pretty inconvenient to edit the file if you want to disable the graph, mainly for testing purpose. Now, you can enable the graph generation using the mkdocs.yml, as here.

To do that, I edited the def on_env in on_env.py:

def on_env(env, config, files, **kwargs):
    if config['extra'].get('generate_graph', True):
        obsidian_graph()
	...
	return on_env

And I removed the line generate_graph() right after the function

Par default, the graph will be generated (aka if you don't set any key). You need to add generate_graph: false to disable it.

---

In case you need, just download the edited file from the template !