{"id":13707648,"url":"https://github.com/jimbrig/obsidian_published","last_synced_at":"2025-10-08T19:06:03.577Z","repository":{"id":105150293,"uuid":"363735633","full_name":"jimbrig/obsidian_published","owner":"jimbrig","description":"Using mkdocs to publish my obsidian vault. Main repo for the vault is https://github.com/jimbrig/obsidian_vault","archived":false,"fork":false,"pushed_at":"2021-06-05T03:46:59.000Z","size":3993,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-05T21:34:54.770Z","etag":null,"topics":["mkdocs","notes","obsidian","obsidian-md","obsidian-notes","obsidian-vault","pkm","publish","website"],"latest_commit_sha":null,"homepage":"https://jimsvault.jimbrig.com/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jimbrig.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}},"created_at":"2021-05-02T19:41:37.000Z","updated_at":"2025-01-02T17:45:46.000Z","dependencies_parsed_at":"2024-01-17T08:44:13.131Z","dependency_job_id":"5c8539f0-3f11-4f50-836f-7064c5c9c9b4","html_url":"https://github.com/jimbrig/obsidian_published","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"jobindjohn/obsidian-publish-mkdocs","purl":"pkg:github/jimbrig/obsidian_published","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimbrig%2Fobsidian_published","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimbrig%2Fobsidian_published/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimbrig%2Fobsidian_published/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimbrig%2Fobsidian_published/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jimbrig","download_url":"https://codeload.github.com/jimbrig/obsidian_published/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimbrig%2Fobsidian_published/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000697,"owners_count":26082805,"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","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["mkdocs","notes","obsidian","obsidian-md","obsidian-notes","obsidian-vault","pkm","publish","website"],"created_at":"2024-08-02T22:01:38.583Z","updated_at":"2025-10-08T19:06:03.559Z","avatar_url":"https://github.com/jimbrig.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# Published Vault\n\n[![Create markdown indexes](https://github.com/jimbrig/obsidian_published/actions/workflows/index.yml/badge.svg)](https://github.com/jimbrig/obsidian_published/actions/workflows/index.yml)\n\n[![Publish Vault](https://github.com/jimbrig/obsidian_published/actions/workflows/publish.yml/badge.svg)](https://github.com/jimbrig/obsidian_published/actions/workflows/publish.yml)\n## Setup\n\n### MkDocs\n\n```powershell\npip install mkdocs\nmkdocs build\nmkdocs serve\nmkdocs gh-deploy\n```\n\n### Plugins\n\n|                  Plugin                   | Version |\n| :---------------------------------------: | :-----: |\n|                  mkdocs                   |  1.1.2  |\n|          mkdocs-autolinks-plugin          |  0.4.0  |\n|        mkdocs-awesome-pages-plugin        |  2.5.0  |\n| mkdocs-git-revision-date-localized-plugin |  0.9.2  |\n|           mkdocs-minify-plugin            |  0.4.0  |\n|          mkdocs-monorepo-plugin           | 0.4.14  |\n|          mkdocs-roamlinks-plugin          |  0.1.3  |\n\n#### Installations\n\n```powershell\n$ pip install mkdocs /\n    mkdocs-autolinks-plugin /\n    mkdocs-awesome-pages-plugin /\n    mkdocs-git-revision-date-localized-plugin /\n    mkdocs-monorepo-plugin /\n    mkdocs-roamlinks-plugin /\n    mkdocs-minify-plugin\n\n$ pip list | grep mkdocs-*\nmkdocs                                    1.1.2\nmkdocs-autolinks-plugin                   0.4.0\nmkdocs-awesome-pages-plugin               2.5.0\nmkdocs-git-revision-date-localized-plugin 0.9.2\nmkdocs-minify-plugin                      0.4.0\nmkdocs-monorepo-plugin                    0.4.14\nmkdocs-roamlinks-plugin                   0.1.3\n```\n\n#### Configuration\n\n```yaml\nplugins:\n  - search\n  - autolinks\n  - roamlinks\n  - awesome-pages\n  - git-revision-date-localized:\n      type: timeago\n  - minify:\n      minify_html: true\nmarkdown_extensions:\n  - toc:\n      permalink: ⚑\n      baselevel: 2\n  - codehilite:\n      linenums: false\n      guess_lang: true\n  - footnotes\n  - abbr\n  - admonition\n  - meta\n  - def_list\n```\n\n### Apendix: Publish Obsidian Notes with MkDocs (template)\n\nWould you like to make some of your [Obsidian](https://obsidian.md/) notes public?\n\nThis template gives you an easy way to publish your Obsidian notes using Github pages.\n\nWith this template, you get these out-of-the-box:\n\n- an awesome website based on Material theme, complete with a search bar (Checkout this template published [here](https://jobindj.github.io/obsidian-mkdocs/))\n- get the Obsidian/Roam style `[[wikilinks]]` from your vault in your published notes\n- Toggle between light and dark mode\n\n#### How to get started?\n\n1. Create a new github repository using [this template](https://github.com/jobindj/obsidian-mkdocs/generate)\n    - Give a name to your public notes repository in this step. By default your notes will be published at `\u003chttps://username.github.io/repo-name/\u003e`\n    - You need to copy only the `main` branch while create the repo from the template\n2. Clone the repository you generated into your Obsidian folder/vault.\n3. Move the notes you would like to make public to the `repo-name/docs` folder.\n    - Easiest way to do this would be using drag and drop within Obsidian\n4. Commit and push the changes. Github actions will publish your notes using [MkDocs](https://www.mkdocs.org/), with the [Material theme](https://squidfunk.github.io/mkdocs-material/).\n\n#### Configuring your website\n\n#### How do I arrange sections and pages?\n\nBy default, the sections and pages will follow the folder structure within `/docs`.\n\n- If you would like to arrange the pages manually, then use the `nav` option in the `mkdocs.yml` [configuration file](https://www.mkdocs.org/#adding-pages) at the root of this repo  to set custom page navigation.\n  - For example, see the setup for [the Blue Book](https://lyz-code.github.io/blue-book/) at [github](https://github.com/lyz-code/blue-book/blob/master/mkdocs.yml). Managing each page using `nav` can become cumbersome as the number of notes increase though!\n- The Materials theme provides multiple options to arrange [sections](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections), use [navigation tabs](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs), and many other helpful [navigation setups](https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/)\n\n#### Alternatives\n\n- [kmaasrud/oboe](https://github.com/kmaasrud/oboe): tool to convert an Obsidian vault into a static directory of HTML files.\n- [Jackiexiao/foam-mkdocs-template](https://github.com/Jackiexiao/foam-mkdocs-template): template for Obsidian/Foam using mkdocs/mkdocs-material/mkdocs-roamlinks-plugin\n- [foambubble/foam-template](https://github.com/foambubble/foam-template): Foam workpace template\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimbrig%2Fobsidian_published","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjimbrig%2Fobsidian_published","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimbrig%2Fobsidian_published/lists"}