+{% endblock %}
\ No newline at end of file
diff --git a/overrides/article.html b/overrides/article.html
new file mode 100644
index 0000000..8eb4b3a
--- /dev/null
+++ b/overrides/article.html
@@ -0,0 +1,7 @@
+{# template #}
+{% extends "index.html" %}
+
+{# content #}
+{% block content %}
+{% include "partials/post-list.html" %}
+{% endblock %}
\ No newline at end of file
diff --git a/overrides/hooks/category.py b/overrides/hooks/category.py
new file mode 100644
index 0000000..0848026
--- /dev/null
+++ b/overrides/hooks/category.py
@@ -0,0 +1,110 @@
+"""
+A simple script that help to create a category in the database. Create the folder and the `index.md` file.
+Usage :
+usage: category.py [-h] [--parent PARENT] [--description DESCRIPTION] [--toc] [--nav] name
+positional arguments:
+ name Name of the category.
+
+options:
+ -h, --help show this help message and exit
+ --parent PARENT Parent category.
+ --description DESCRIPTION Description of the category.
+ --toc hide toc
+ --nav hide nav
+"""
+
+import argparse
+import yaml
+from pathlib import Path
+import re
+
+
+def create_category(path, index_contents):
+ path.mkdir(parents=True, exist_ok=True)
+ index_file = Path(path, "index.md")
+ with open(index_file, "w", encoding="utf-8") as f:
+ f.write(index_contents.lstrip())
+
+
+def index_contents(name, description_yaml, hider, description):
+ index_contents = f"""
+ ---
+ index: true{description_yaml}
+ hidden: true
+ category: {name}
+ template: article.html
+ comments: false
+ title: {name}{hider}
+ ---
+ {description}
+ """
+ index_contents = re.sub(" ", "", index_contents)
+ return index_contents
+
+
+def resolving_args(args, docs_dir):
+ if args.parent:
+ path = Path(docs_dir, args.parent, args.name)
+ else:
+ path = Path(docs_dir, args.name)
+ if args.description:
+ description_yaml = "\ndescription: " + args.description
+ description_contents = args.description
+ else:
+ description_yaml = ""
+ description_contents = ""
+ hider = []
+ if args.toc:
+ hider.append("toc")
+ if args.nav:
+ hider.append("navigation")
+ hider = "\nhide:\n- " + "\n- ".join(hider) if hider else ""
+ return path, description_yaml, hider, description_contents
+
+
+def main():
+ parser = argparse.ArgumentParser(
+ description="Create a new category your mkdocs documentations from your docs (or configured directory)."
+ )
+ parser.add_argument("name", help="Name of the category.")
+ parser.add_argument(
+ "--parent", help='Parent category, in path. Example : "category/subcategory"'
+ )
+ parser.add_argument("--description", help="Description of the category.")
+ parser.add_argument("--toc", help="hide toc", action="store_true")
+ parser.add_argument("--nav", help="hide nav", action="store_true")
+ parser.add_argument(
+ "--dry-run",
+ help="Dry run, do not create the category, just log",
+ action="store_true",
+ )
+ args = parser.parse_args()
+
+ mkdocs_config = Path("mkdocs.yml").resolve()
+ with open(mkdocs_config, "r", encoding="utf-8") as f:
+ config = yaml.load(f, Loader=yaml.BaseLoader)
+ docs_dir = config.get("docs_dir", "docs")
+ docs_dir = Path(docs_dir).resolve()
+ path, description_yaml, hider, description_contents = resolving_args(args, docs_dir)
+ index = index_contents(args.name, description_yaml, hider, description_contents)
+ if not args.dry_run:
+ print("📤 Creating category 📤...")
+ print(
+ f"\nArguments used :\n- Name: {args.name}\n- Parents: {args.parent}\n- Description: {args.description}\n- Toc: {args.toc}\n- Nav: {args.nav}\n"
+ )
+ print(f"📌 Creating with path : {path}")
+ create_category(path, index)
+ print("Category created ! 🎉")
+ else:
+ print("🐍 Dry Run 🐍")
+ print(
+ f"\nArguments used :\n- Name: {args.name}\n- Parents: {args.parent}\n- Description: {args.description}\n- Toc: {args.toc}\n- Nav: {args.nav}\n"
+ )
+ print(f"🚃 Path : {path}")
+ print(f"🗃️ Index : {index}")
+
+
+if __name__ == "__main__":
+ main()
+ print("Done.")
+ exit(0)
diff --git a/overrides/hooks/on_env.py b/overrides/hooks/on_env.py
new file mode 100644
index 0000000..18c6e24
--- /dev/null
+++ b/overrides/hooks/on_env.py
@@ -0,0 +1,200 @@
+import os
+import re
+import urllib.parse
+import datetime
+from pathlib import Path
+
+import mkdocs.structure.pages
+from babel.dates import format_date
+from dateutil import parser
+
+
+def get_last_part_URL(url):
+ """Get the last part of an URL.
+
+ Args:
+ url (str): the URL
+
+ Returns:
+ str: the last part of the URL
+ """
+ if not url.endswith("/"):
+ url = url + "/"
+ head, tail = os.path.split(url)
+ return "/" + tail if tail != "" else ""
+
+
+def regex_replace(s, find, replace):
+ """A non-optimal implementation of a regex filter"""
+ return re.sub(find, replace, s)
+
+
+def log(text):
+ """Prints text to the console, in case you need to debug something.
+
+ Using mainly in the template files.
+ Parameters:
+ text (str): The text to print.
+ Returns:
+ str: An empty string.
+ """
+ print(text)
+ return ""
+
+
+def time_time(time):
+ """Converts a time string to a human-readable format.
+
+ Parameters:
+ time (any): The time string to convert.
+ Returns:
+ str|datetime: The converted time.
+ """
+ time = time.replace("-", "/")
+ time = parser.parse(time).isoformat()
+ try:
+ time = datetime.datetime.fromisoformat(time)
+ return datetime.datetime.strftime(time, "%d %B %Y")
+ except AttributeError:
+ return datetime.datetime.strftime(str(time), "%d %B %Y")
+ except ValueError:
+ print("value error!")
+ return time
+
+
+def to_local_time(time, locale):
+ """Convert to local time.
+
+ Args:
+ time (any): the time to convert
+ locale (any): the locale to use
+
+ Returns:
+ str: the converted time
+ """
+ if isinstance(time, datetime.time) or isinstance(time, datetime.date):
+ time = time.isoformat()
+ date = time.replace("-", "/")
+ date = parser.parse(date)
+ return format_date(date, locale=locale)
+
+
+def time_todatetime(time):
+ """convert time to datetime.
+
+ Args:
+ time (any): time to convert
+
+ Returns:
+ datetime: the converted time
+ """
+ return parser.parse(time)
+
+
+def time_to_iso(time):
+ """Convert time to ISO format.
+
+ Args:
+ time (any): Time to convert
+
+ Returns:
+ any|str: convert time or the original time if error
+ """
+ if isinstance(time, datetime.time) or isinstance(time, datetime.date):
+ time = time.isoformat()
+ time = time.replace("-", "/")
+ try:
+ return parser.parse(time).isoformat()
+ except AttributeError:
+ return time
+
+
+def page_exists(page):
+ """Check if a page exists.
+
+ Args:
+ page (any): The page to check
+
+ Returns:
+ bool: true if exists
+ """
+ return Path(page).exists()
+
+
+def url_decode(url):
+ """decode an url in a template.
+
+ Args:
+ url (any): THE URL
+
+ Returns:
+ str : the decoded url
+ """
+ return urllib.parse.unquote(url)
+
+
+def value_in_frontmatter(key, metadata):
+ """Check if a key exists in a dictionnary.
+
+ Args:
+ key (any): the key to check
+ metadata (any): the dictionnary to check
+
+ Returns:
+ bool: true if exists
+ """
+ if key in metadata:
+ return metadata[key]
+ else:
+ return None
+
+
+def icon_exists(path, config):
+ path = Path(config["docs_dir"]) / "_assets" / path
+ return Path(path).exists()
+
+
+def replace_by_name(name: list[str] | str):
+ if isinstance(name, list):
+ return " ".join(name)
+ return name
+
+
+def first(name: list[str] | str):
+ if isinstance(name, list):
+ return name[0]
+ return name
+
+
+def links(name: list[str] | str):
+ if isinstance(name, list):
+ return "/".join(name)
+ return name
+
+
+def is_section(path):
+ if isinstance(path, mkdocs.structure.pages.Page):
+ return False
+ return True
+
+
+def on_env(env, config, files, **kwargs):
+ static_path = os.path.join(config["docs_dir"], "_assets")
+ if static_path not in env.loader.searchpath:
+ env.loader.searchpath.append(static_path)
+ env.filters["convert_time"] = time_time
+ env.filters["iso_time"] = time_to_iso
+ env.filters["time_todatetime"] = time_todatetime
+ env.filters["page_exists"] = page_exists
+ env.filters["url_decode"] = url_decode
+ env.filters["log"] = log
+ env.filters["to_local_time"] = to_local_time
+ env.filters["value_in_frontmatter"] = value_in_frontmatter
+ env.filters["regex_replace"] = regex_replace
+ env.filters["get_last_part_URL"] = get_last_part_URL
+ env.filters["icon_exists"] = lambda path: icon_exists(path, config)
+ env.filters["is_section"] = is_section
+ env.filters["replace_by_name"] = replace_by_name
+ env.filters["first"] = first
+ env.filters["links"] = links
+ return env
diff --git a/overrides/hooks/on_page_markdown.py b/overrides/hooks/on_page_markdown.py
new file mode 100644
index 0000000..9d498dc
--- /dev/null
+++ b/overrides/hooks/on_page_markdown.py
@@ -0,0 +1,51 @@
+import re
+
+
+def non_breaking_space(markdown):
+ return re.sub(
+ "[\u00a0\u1680\u180e\u2000-\u200b\u202f\u205f\u3000\ufeff]", " ", markdown
+ )
+
+
+def update_heading(markdown):
+ file_content = markdown.split("\n")
+ markdown = ""
+ code = False
+ for line in file_content:
+ if not code:
+ if line.startswith("```"):
+ code = True
+ elif line.startswith("#") and line.count("#") <= 5:
+ heading_number = line.count("#") + 1
+ line = "#" * heading_number + " " + line.replace("#", "")
+ elif line.startswith("```") and code:
+ code = True
+ markdown += line + "\n"
+ return markdown
+
+
+def strip_comments(markdown):
+ return re.sub(r"%%.*?%%", "", markdown, flags=re.DOTALL)
+
+
+def fix_tags(metadata):
+ tags = metadata.get("tags", None) or metadata.get("tag", None)
+ if tags and isinstance(tags, str):
+ tags = tags.split("/")
+ tags = [tag.strip() for tag in tags]
+ metadata["tags"] = tags
+ return metadata
+
+
+def on_page_markdown(markdown, files, page, config, **kwargs):
+ config_hooks = config.get(
+ "extra", {"hooks": {"strip_comments": True, "fix_heading": False}}
+ ).get("hooks", {"strip_comments": True, "fix_heading": False})
+ if config_hooks.get("strip_comments", True):
+ markdown = strip_comments(markdown)
+ if config_hooks.get("fix_heading", False):
+ markdown = update_heading(markdown)
+ metadata = fix_tags(page.meta)
+ page.meta = metadata
+ markdown = non_breaking_space(markdown)
+ return markdown
diff --git a/overrides/hooks/on_post_page.py b/overrides/hooks/on_post_page.py
new file mode 100644
index 0000000..d2a5ce7
--- /dev/null
+++ b/overrides/hooks/on_post_page.py
@@ -0,0 +1,15 @@
+from bs4 import BeautifulSoup
+
+
+def on_post_page(output, page, config) -> str:
+ soup = BeautifulSoup(output, "html.parser")
+ for a_tag in soup.find_all("a", {"class": "ezlinks_not_found"}):
+ a_tag["class"] = a_tag.get("class", []) + ["ezlinks_not_found"]
+ new_tag = soup.new_tag("span")
+ new_tag.string = a_tag.string or a_tag.get("href", "File not found")
+ for attr in a_tag.attrs:
+ if attr != "href":
+ new_tag[attr] = a_tag[attr]
+ new_tag["src"] = a_tag["href"]
+ a_tag.replaceWith(new_tag)
+ return str(soup)
diff --git a/overrides/index.html b/overrides/index.html
new file mode 100644
index 0000000..08f9424
--- /dev/null
+++ b/overrides/index.html
@@ -0,0 +1,25 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+
+
+
+
+
+ {% include "partials/meta.html" %}
+{% endblock %}
+{% block content %}
+ {{ super() }}
+{% endblock %}
\ No newline at end of file
diff --git a/overrides/main.html b/overrides/main.html
new file mode 100644
index 0000000..a39ff1c
--- /dev/null
+++ b/overrides/main.html
@@ -0,0 +1,40 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+
+
+
+
+
+ {% include "partials/meta.html" %}
+{% endblock %}
+{% block content %}
+ {{ super() }}
+ {% include "partials/css_class.html" %}
+ {% include "partials/comments.html" %}
+ {% set pg_title = 'title' | value_in_frontmatter(page.meta) %}
+ {% set pg_title = page.meta.title if pg_title is not none else page.title %}
+ {% set pg_title = page.parent.title if pg_title == 'Index' else pg_title %}
+
+{% endblock %}
\ No newline at end of file
diff --git a/overrides/partials/comments.html b/overrides/partials/comments.html
new file mode 100644
index 0000000..9e94ea2
--- /dev/null
+++ b/overrides/partials/comments.html
@@ -0,0 +1,12 @@
+{% set local_comments = "comments" | value_in_frontmatter(page.meta) %}
+{% set config_comments = "comments" | value_in_frontmatter(config.extra) %}
+{% set config_comments = False if config_comments is none else config.extra["comments"] %}
+{% set comments = config_comments if local_comments is none else page.meta['comments'] %}
+{% if comments %}
+
+
+{% endif %}
\ No newline at end of file
diff --git a/overrides/partials/content.html b/overrides/partials/content.html
new file mode 100644
index 0000000..d65296b
--- /dev/null
+++ b/overrides/partials/content.html
@@ -0,0 +1,54 @@
+
+
+
+{% if "material/tags" in config.plugins %}
+{% include "partials/tags.html" %}
+{% endif %}
+
+
+{% include "partials/actions.html" %}
+
+
+{% if "\x3ch1" not in page.content and not config.extra['no-auto-h1'] %}
++ {{ pg_title }} +
++ {{ pg_description }} +
++ + {% include ".icons/material/calendar.svg" %} + + + {{ pg.new_date }} + + {% if pg_category | length > 1 %} + + + {% include ".icons/material/folder.svg" %} + + {{ pg_category }} + + {% endif %} +
+
+ {% endif %}
+ {% for pg in pg_group %}
+ {% set pg_image = "" %}
+ {% set pg_category = "" %}
+ {% set pg_description = "" %}
+ {% set category_link = "" %}
+ {% set pg_title = pg.title %}
+ {% if pg_title == "Index" %}
+ {% set pg_title = pg.parent.title %}
+ {% endif %}
+ {% set main_category = page.meta.category | first | lower %}
+ {% if pg.meta %}
+ {% if pg.meta.title %}
+ {% set pg_title = pg.meta.title %}
+ {% endif %}
+ {% if pg.meta.banner %}
+ {% set pg_image = pg.meta.banner %}
+ {% elif pg.meta.image %}
+ {% set attachmentsFolder = 'attachments' | value_in_frontmatter(config.extra) %}
+ {% set attachmentsFolder = 'assets/img/' if attachmentsFolder is none else config.extra['attachments'] | regex_replace('/$', '') %}
+ {% set pg_image = config.site_url ~ attachmentsFolder ~ '/' ~ pg.meta.image %}
+ {% endif %}
+ {% if pg.meta.category %}
+ {% set pg_category = pg.meta.category | replace_by_name | lower | replace(main_category, '') | replace('/', '') | title %}
+ {% if pg_category | length > 1 %}
+ {% set category_link = config.docs_dir ~ "/" ~ page.meta.category ~ '/' ~ pg_category ~ '/index.md' %}
+ {% set category_exists = category_link | page_exists %}
+ {% if category_exists %}
+ {% set link = pg.meta.category | links %}
+ {% set link = config.site_url ~ link ~ '/' %}
+ {% set pg_category = '' ~ pg_category ~ '' %}
+ {% endif %}
+ {% endif %}
+ {% endif %}
+ {% if pg.meta.description %}
+ {% set pg_description = pg.meta.description | truncate(200)%}
+ {% endif %}
+ {% endif %}
+
+ {% endfor %}
+
+
+ {% endfor %}
+
+ 
+ {% endif %}
+
+
+
+ {% if pg_image %}
+
+
+
+
+