PROJECT DOCUMENTATION

OBSIDIAN TO MKDOCS

The script's goal is to move an authorized file (or multiple authorized file) from your Obsidian's vault to your blog's repository. It will :

Furthermore, it will also carry :

File's front matter

The script relies on the front matter** of the notes you want to publish.

  1. share: true allow publishing the file3
  2. category to choose where the file will be after conversion ; allowing categorization for the blog.4
    • category: false will hide the file from navigation.
    • category: hidden will do the same.
    • category: folder1/folder2/ will move the file in folder2, under folder1
    • category: folder1/folder2/filename will rename the file index and allow support of section's index page
  3. update: false prevent to update the file after the first publication
  4. description : Add a description to the file (for meta-tag sharing)5
  5. title : Change the title in the navigation.
  6. image : Add an image for meta-tags sharing.5 It needs to be the name of the file, as image.png.

Usage

The script can be use :

The supported system are :

Configuration

At the first run, you will be asked to configure some key and specific path.

  1. Vault : Use the file dialog to choose your vault folder.
  2. Publish repository folder : As vault path, use the file dialog.
  3. share : You can change the share key. By default, it's share
  4. Index key: Support for citation of pagination index pages. By default, it uses (i)
  5. Default blog folder: By default, the notes will be in docs/notes but you can change that, or use / for root.

The file will be in site-packages/mkdocs_obsidian/.mkdocs_obsidian (unless for Pyto : the .env will be directly in site_package/.mkdocs_obsidian)

Terminal

Global options :

  • --git : No commit and push to git ;
  • --mobile : Use mobile shortcuts instead of --git
  • --meta : Update frontmatter of source files
  • --keep : Don't delete files in blog folder
  • --shell : Remove Rich printing

Commands and specific options :

  • config : (it will ignore --use configuration_name)
    • --new configuration_name : Create a specific configuration for some files
  • all : Share all vault
    • --force : Force updating (ignore the difference between the source and blog file)
    • --vault : Share all vault file, ignoring the share state.
  • file [file*] : Share only one file
usage: __main__.py [-h] [--mobile | --git] [--meta] [--keep] [--use configuration_name] {config,all,file} ...

positional arguments:
  {config,all,file}
    config              Configure the script : Add or edit your vault and blog absolute path, change some keys.
    all                 Publish multiple files
    file                Publish only one file

options:
  -h, --help            show this help message and exit
  --mobile, --shortcuts
                        Use mobile shortcuts, without push
  --git, --g, --G       No commit and no push to git
  --meta, --m, --M      Update the frontmatter of the source file, adding the note blog's link
  --keep, --k, --K      Keep deleted file from vault and removed shared file
  --use configuration_name, --config configuration_name
                        Use a different config from default

The commands order is : obs2mk (global_options) [all|config|file FILEPATH] (specific_options) Where :

  • Global and specific options are optional
  • all, config and file6 are required You can use the command without argument with obs2mk to share every share: true file in your vault.

Share one file : obs2mk file FILEPATH

It will :

  • Update the share state in original file
  • Convert one file, regardless of what is the share state.

Share all file : obs2mk all or obs2mk

You can share multiple documents at once with scanning your Vault, looking for the share: true. It will convert automatically these files.
Only file with modification since the last sharing will be updated.

You can :

  • Share entirely your vault (that's ignore the share state) with : obs2mk all --vault
  • Ignore the difference between the source file and the blog's file with : obs2mk all --force Also, you can combine the two options.

Configuration

You can use and create multiple configuration files. This allows to have multiple site based on one vault, or different vault accross one site...

  1. To create a new configuration file : obs2mk config --new configuration_name
  2. To use a configuration use : --use configuration_name For example : obs2mk --use configuration_name

  1. Deprecated ; Will don't be updated and be removed in future version. ↩

  2. Support nested callout :D ↩

  3. This key can be configured ↩

  4. You can customize the folder with Awesome Pages ↩

  5. Meta tags are snippets of text that describe a page’s content; the meta tags don’t appear on the page itself, but only in the page’s source code. Meta tags are essentially little content descriptors that help tell search engines what a web page is about. (source) ↩ ↩2

  6. For file you need to add the filepath of the file you want to share : obs2mk (global_option) file "filepath" (specific_options) ↩

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (5.0.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for mara-li from gravatar.com mara-li

Credits

Author: Mara-Li

License

GNU Affero General Public License v3 or later (AGPLv3+) (AGPL)

Requires

Python >=3.9

Tags

obsidian obsidian.md free publish publish mkdocs material

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obs2mk-3.3.0.tar.gz (35.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

obs2mk-3.3.0-py3-none-any.whl (37.1 kB view details)

Uploaded Python 3

File details

Details for the file obs2mk-3.3.0.tar.gz.

File metadata

  • Download URL: obs2mk-3.3.0.tar.gz
  • Upload date:
  • Size: 35.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.12

File hashes

Hashes for obs2mk-3.3.0.tar.gz
Algorithm Hash digest
SHA256 d4ec891aa3fe7d4df2a33e7ead07c02e1a1b1758af8c25226c71149672d33d1a
MD5 e9e50c114d896982f47022d9d045a60f
BLAKE2b-256 61bd419d8335334ac16213ae90fba4704da499ab0367a07f85e871ec0509bbb9

See more details on using hashes here.

File details

Details for the file obs2mk-3.3.0-py3-none-any.whl.

File metadata

  • Download URL: obs2mk-3.3.0-py3-none-any.whl
  • Upload date:
  • Size: 37.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.12

File hashes

Hashes for obs2mk-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 acfce8ae184b6d43c2e484d7afd7a45edcbc1ed6ca7828ec2626ecd971c68bd5
MD5 0862370243a20be1e882959ea7ccb433
BLAKE2b-256 04d6588f759bb3845e0ce01dc29cb78b911e918c0ac60e118592ba71ed16cf0f

See more details on using hashes here.

Release history Release notifications | RSS feed

5.0.0

2 files

4.1.2

2 files

4.1.1

2 files

4.1.0

2 files

4.0.6

2 files

4.0.5

2 files

4.0.4

2 files

4.0.3

2 files

4.0.2

2 files

4.0.1

2 files

4.0.0

2 files

3.7.1

2 files

3.7.0

2 files

3.6.4

2 files

3.6.3

2 files

3.6.2

2 files

3.6.1

2 files

3.6.0

2 files

3.5.4

2 files

3.5.3

2 files

3.5.2

2 files

3.5.1

2 files

3.5.0

2 files

3.4.0

2 files

3.3.2

2 files

3.3.1

2 files

This release

3.3.0 This release

2 files

3.2.4

2 files

3.2.3

2 files

3.2.2

2 files

3.2.1

2 files

3.2.0

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.12.1

2 files

1.12.0

2 files

1.11.17

2 files

1.11.16

2 files

1.11.15

2 files

1.11.14

2 files

1.11.13

2 files

1.11.12

2 files

1.11.11

2 files

1.11.10

2 files

1.11.9

2 files

1.11.8

2 files

1.11.7

2 files

1.11.6

2 files

1.11.5

2 files

1.11.4

2 files

1.11.3

2 files

1.11.2

2 files

1.11.1

2 files

1.11.0

2 files

1.10.0

2 files

1.9.4

2 files

1.9.3

2 files

1.9.2

2 files

1.9.1

2 files

1.9.0

2 files

1.8.6

2 files

1.8.5

2 files

1.8.4

2 files

1.8.3

2 files

1.8.2

2 files

1.8.1

2 files

1.8.0

2 files

1.7.4

2 files

1.7.3

2 files

1.7.2

2 files

1.7.1

2 files

1.7.0

2 files

1.6.0

2 files

1.5.0

2 files

1.4.0

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.6

2 files

1.2.5

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.8

2 files

1.1.7

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.1

2 files

0.3.0

2 files

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.2

2 files

0.1.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page