{"id":17744108,"url":"https://github.com/extratone/idiot","last_synced_at":"2026-01-11T05:34:52.537Z","repository":{"id":59072835,"uuid":"528674076","full_name":"extratone/idiot","owner":"extratone","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-21T00:44:32.000Z","size":6050,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-21T04:09:09.251Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/extratone.png","metadata":{"files":{"readme":"README-FR.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-25T03:01:45.000Z","updated_at":"2024-10-21T00:44:35.000Z","dependencies_parsed_at":"2023-12-26T01:35:53.984Z","dependency_job_id":"88b0b86f-63fc-4d60-83b2-948d920f6b1f","html_url":"https://github.com/extratone/idiot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"Enveloppe/mkdocs-publisher-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/extratone%2Fidiot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/extratone%2Fidiot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/extratone%2Fidiot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/extratone%2Fidiot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/extratone","download_url":"https://codeload.github.com/extratone/idiot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246569006,"owners_count":20798341,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-26T06:41:58.743Z","updated_at":"2026-01-11T05:34:52.513Z","avatar_url":"https://github.com/extratone.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ntitle: Configuration\n---\n\n- [Obsidian Plugin](https://github.com/ObsidianPublisher/obsidian-github-publisher)\n- [Template](https://github.com/ObsidianPublisher/obsidian-mkdocs-publisher-template)\n- [Documentation](https://obsidian-publisher.netlify.app)\n\n## Configuration de Mkdocs\n\nVous avez besoin de configurer à la fois le module Obsidian et mkdocs afin que tout fonctionne proprement.\n\nVous pouvez obtenir plus d'information au sujet de la création de site via Material Mkdocs [ici](https://squidfunk.github.io/mkdocs-material/creating-your-site/#advanced-configuration).\n\nAu sein de votre template nouvellement clonée, vous trouverez un `mkdocs.yml`. Ce fichier vous permet de personnaliser votre blog ! \n\nLes plus importants à éditer :\n1. `site_name` \n2. `site_description`\n3. `site_url` (critique) : Par défaut, c'est `https://github_username.io/repo_name` [^1]\n\nPour modifier le logo et le favicon, mettez d'abord le fichier choisi dans `assets/logo`, et changez `logo` et `favicon` :\n1. `logo : assets/meta/logo_name.png`\n2. `favicon : assets/meta/favicon.png`.\n3. `extra` : `SEO : 'assets/meta/LOGO_SEO.png'` afin de faire fonctionner proprement les SEO.\n\nVous pouvez personnaliser :\n- Police\n- Schéma de couleurs, palette, icônes \n- Langue  \n\n[Consultez la documentation pour obtenir plus d'informations](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/)\n\nVous n'avez pas besoin de toucher à quoi que ce soit dans `features` ; `markdown_extensions...`\n\n### Extra configuration\n\nLa dernière partie du fichier mkdocs est une configuration pour les `hooks` et la template Jinja affichant la liste des articles (`blog_list.html`).\n\n#### Liste des articles\n\nLa liste des articles est configuré par la clé `blog_list` et peut prendre les paramètres suivants : \n\n- `pagination` (*`boolean, defaut: True`*) : Affiche une pagination si la liste est trop longue.\n- `pagination_message` (*`boolean, defaut: True`*) : Affiche un message indiquant le nombre de postes (fichier) dans le dossier.\n- `pagination_translation` (*`string, defaut: 'posts in'`*) : Traduction du message de pagination.\n\nConfiguration par défaut : \n```yml\nextra:\n    blog_list:\n        pagination: true\n        pagination_message: true\n        pagination_translation: 'posts in'\n```\n\n#### Hooks\n\nCette partie contient la configuration des `hooks`, des programmes courts en python qui permettent de patch certaines parties de Obsidian incompatibles avec Mkdocs.\n\nVous pouvez y configurer :\n- La suppression des commentaires Obsidian (`%% comments %%`) : `strip_comments: true`\n- Un fix pour les titres, qui rajoute un `#` à tous les titres (sauf le 6e) car le TOC de Mkdocs considère que le H1 est le titre principal/titre du fichier : `fix_heading : true`\n\nConfiguration par défaut : \n```yml\nextra:\n  hooks:\n    strip_comments: true\n    fix_heading: false\n```\n\n## Test local (*optionnel*)\n\nPour faire fonctionner le blog en local, vous devez installer les pré-requis et lancer `mkdocs serve`.\n```\ncd publish_blog\npip install -r requirements.txt\nmkdocs serve\n```\nUn petit conseil : Vous pouvez utiliser un environnement [conda](https://docs.conda.io/en/latest/) ici (ou un venv, mais je n'aime pas venv). Utilisez simplement ceci :\n``bash\nconda create -n Publisher python=3.10.4\nconda activate Publisher\n```\nJuste avant l'installation du `pip` !\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fextratone%2Fidiot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fextratone%2Fidiot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fextratone%2Fidiot/lists"}