{"id":20846657,"url":"https://github.com/yohn/obs","last_synced_at":"2026-03-09T18:17:20.869Z","repository":{"id":232229164,"uuid":"655067256","full_name":"Yohn/obs","owner":"Yohn","description":"Testing Github Publisher for Obsidian","archived":false,"fork":false,"pushed_at":"2023-06-17T19:28:03.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-19T05:10:15.682Z","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/Yohn.png","metadata":{"files":{"readme":"README.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}},"created_at":"2023-06-17T19:27:59.000Z","updated_at":"2023-06-17T19:28:08.000Z","dependencies_parsed_at":"2024-04-08T19:23:51.146Z","dependency_job_id":"d37e262e-3ccc-4cc6-a77b-57791e9e9851","html_url":"https://github.com/Yohn/obs","commit_stats":null,"previous_names":["yohn/obs"],"tags_count":0,"template":false,"template_full_name":"Enveloppe/mkdocs-publisher-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yohn%2Fobs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yohn%2Fobs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yohn%2Fobs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yohn%2Fobs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yohn","download_url":"https://codeload.github.com/Yohn/obs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243213850,"owners_count":20254879,"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-11-18T02:17:19.482Z","updated_at":"2025-12-11T18:04:22.479Z","avatar_url":"https://github.com/Yohn.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 :\n  - To use with [Github Pages](https://github.com/ObsidianPublisher/template-gh-pages)\n  - With [Netlify](https://github.com/ObsidianPublisher/template-netlify-vercel)\n- [Documentation](https://obsidian-publisher.netlify.app/)\n- [Github Discussion](https://github.com/ObsidianPublisher/obsidian-github-publisher/discussions)\n\n## Mkdocs configuration\n\nYou need to configure the plugin and the `mkdocs` configuration for it to work properly.\n\nYou can find more information about creating the site using the [Material Mkdocs Documentation](https://squidfunk.github.io/mkdocs-material/creating-your-site/#advanced-configuration).\n\nIn the repository that you cloned, you will find a `mkdocs.yml` file. This file allows you to customize your blog. The most important settings to edit are:\n\n1. `site_name`\n2. `site_description`\n3. `site_url` (critical): By default, it's `https://github_username.io/repo_name`[^1]\n\nTo edit the logo and favicon, first put the chosen files in the `assets/logo` directory, and then change `logo` and `favicon`:\n\n1. `logo: assets/meta/logo_name.png`\n2. `favicon: assets/meta/favicon.png`\n3. To properly work with SEO, also edit the `extra` with `SEO: 'assets/meta/LOGO_SEO.png'`\n\nYou can also customize:\n\n- Font\n- Color scheme, palette, and icons\n- Language\n\n[Check the documentation for more information](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/)\n\nYou don't need to touch anything in `features` or `markdown_extensions`.\n\n### Extra configuration\n\nThe last part of the `mkdocs.yml` is a configuration for the `hooks` and the template Jinja displaying the list of articles (`blog_list.html`).\n\nThere are also :\n\n- `SEO` (_`string`_): Link to your default image displayed by the SEO.\n- `comments` (_`boolean`_) : Allow the comments block at the end of the page\n- `generate_graph` (_`boolean`_): Generate the [[customization#Graph view|graph view]]\n- `attachments` (_`boolean`_): For [[configuration#Blog list (article listing)]] and image in SEO. Change it according to your Obsidian Plugin settings.\n\n#### Blog list (article listing)\n\nThe list of articles is configured by the key `blog_list` and can take the following parameters :\n\n- `pagination` (_`boolean, default: True`_): Display a pagination if the list is too long.\n- `pagination_message` (_`boolean, default: True`_): Display a message with the number of posts (article/file) in the folder.\n- `pagination_translation` (`string, default: 'posts in'`): Translation of the pagination's message.\n- `no_page_found` (`string, default: \"No pages found!\"`): The text to display if no pages were found.\n\n#### Hooks\n\nThis part contains the configuration of `hooks`, short python scripts that allow to patch some Obsidian parts incompatible with Mkdocs.\n\nYou can configure :\n\n- The suppression of the Obsidian's comments (`%% comments %%`): `strip_comments: true`\n- A fix for headings, which adds a `#` to all headings (except the 6th one) because the Mkdocs TOC considers that the H1 is the main heading/title of the file: `fix_heading: true`\n\n## Local testing\n\nTo run the blog locally, you need to install the requirements and run `mkdocs serve`.\n\n`cd publish_blog pip install -r requirements.txt mkdocs serve`\n\nA tip: You can use a [conda](https://docs.conda.io/en/latest/) environment here (or a venv, but I prefer conda). Just use this command:\n\n```bash\nconda create -n Publisher python=3.11\nconda activate Publisher\n```\n\nRun this command just before running `pip install`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyohn%2Fobs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyohn%2Fobs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyohn%2Fobs/lists"}