Skip to main content

A script to share your obsidian vault (in partial way) using mkdocs

Project description

The script can be use :

The supported system are :

Script's 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 [[../Template - The blog/customization and css#folder-note|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.

Commands

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 file[^1] 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.

Multiple configurations

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

See [[configuration template]] for more information about the configuration file.


Navigation

[^1]: For file you need to add the filepath of the file you want to share : obs2mk (global_option) file "filepath" (specific_options)

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

obs2mk-5.0.0.tar.gz (61.5 kB view details)

Uploaded Source

Built Distribution

obs2mk-5.0.0-py3-none-any.whl (39.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: obs2mk-5.0.0.tar.gz
  • Upload date:
  • Size: 61.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/35.0 requests/2.28.0 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.11.4 keyring/23.6.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.4

File hashes

Hashes for obs2mk-5.0.0.tar.gz
Algorithm Hash digest
SHA256 703adfd84c247f59af2d2cd1c9a7e59185cdfa128f1be48a6eedcbe9e2632011
MD5 f203e4786269e4747c48ce446e26fd4f
BLAKE2b-256 eacfcac11a59f69a5ade6849f8857334b8bd947770d1b5e0a741b89f4f274e52

See more details on using hashes here.

File details

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

File metadata

  • Download URL: obs2mk-5.0.0-py3-none-any.whl
  • Upload date:
  • Size: 39.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/35.0 requests/2.28.0 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.11.4 keyring/23.6.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.4

File hashes

Hashes for obs2mk-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f75be7e16e3c40d434b6baf8151d8cd2d06e59109884a372b2478e30b640285
MD5 b8e73a799a1c74fb75ab269b2b4f350b
BLAKE2b-256 9c2089d8514cb3e11c77ed1a78fbf80f03892c37a5151543d1b8db8b8eb176e5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page