The script can be use :
- Directly in Obsidian, using Obsidian Shell Commands (see Obsidian shell configuration )
- In a terminal.
The supported system are :
- macOS, Linux and Windows
- IOS (with Pyto and/or a-shell with Working Copy)
Script's Configuration
At the first run, you will be asked to configure some key and specific path.
- Vault : Use the file dialog to choose your vault folder.
- Publish repository folder : As vault path, use the file dialog.
- share : You can change the
sharekey. By default, it'sshare - Index key: Support for citation of [[../Template - The blog/customization and css#folder-note|pagination index pages]]. By default, it uses
(i) - Default blog folder: By default, the notes will be in
docs/notesbut 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,configandfile1 are required You can use the command without argument withobs2mkto share everyshare: truefile in your vault.
Share one file : obs2mk file FILEPATH
It will :
- Update the
sharestate in original file - Convert one file, regardless of what is the
sharestate.
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
sharestate) with :obs2mk all --vault - Ignore the difference between the source file and the blog's file with :
obs2mk all --forceAlso, 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...
- To create a new configuration file :
obs2mk config --new configuration_name - To use a configuration use :
--use configuration_nameFor example :obs2mk --use configuration_name
See [[configuration template]] for more information about the configuration file.
Navigation
-
For
fileyou need to add the filepath of the file you want to share :obs2mk (global_option) file "filepath" (specific_options)↩
1 maintainer
Metadata
1 maintainer
Release files for obs2mk 5.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| obs2mk-5.0.0.tar.gz | 61.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| obs2mk-5.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 100.6 kB
Release files / obs2mk-5.0.0.tar.gz
| Download URL | obs2mk-5.0.0.tar.gz |
|---|---|
| Size | 61.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
703adfd84c247f59af2d2cd1c9a7e59185cdfa128f1be48a6eedcbe9e2632011
|
|
BLAKE2b-256 checksum How to use checksums |
eacfcac11a59f69a5ade6849f8857334b8bd947770d1b5e0a741b89f4f274e52
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / obs2mk-5.0.0-py3-none-any.whl
| Download URL | obs2mk-5.0.0-py3-none-any.whl |
|---|---|
| Size | 39.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9f75be7e16e3c40d434b6baf8151d8cd2d06e59109884a372b2478e30b640285
|
|
BLAKE2b-256 checksum How to use checksums |
9c2089d8514cb3e11c77ed1a78fbf80f03892c37a5151543d1b8db8b8eb176e5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for obs2mk 5.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
