A script to share your obsidian vault (in partial way)
Project description
Table Of Content
⚠️ The script and site are not a replacement for Obsidian Publish, which is a much more efficient way to share Obsidian files.
Get Started
- You first need to create a template using YAFPA-blog
- After, do
pip install YAFPA
Requirements
The script uses :
- PyGithub
- Python-dotenv
- python-frontmatter
- Pyperclip on Windows/MacOS/Linux | IOS : Pasteboard (Pyto) or clipboard (Pythonista) | Clipboard function doesn't work (yet) on a-shell.
You can install all with pip install -r requirements.txt
Environment
The first time you use the script, it will ask you three things :
- Your vault path (absolute path !)
- The path of the blog (absolute too !)
- The link of your blog, as
https://my-awesome-blog.netlify.app/
You can reconfig the path with yafpa --config
Script
usage: yafpa [-h] [--preserve | --update] [--filepath FILEPATH] [--git] [--keep] [--config]
Create file in folder, move image in assets, convert to relative path, add share support, and push to git
optional arguments:
-h, --help
: show this help message and exit--preserve, --p, --P
: Don't delete file if already exist--update, --u, --U
: force update : delete all file and reform.--filepath FILEPATH, --f FILEPATH, --F FILEPATH
: Filepath of the file you want to convert--git, --g, --G
: No commit and no push to git--keep, --k
: Keep deleted file from vault and removed shared file--config, --c
: Edit the config file
Checking differences
The script will convert all file with share:true
and check if the contents
are differents with the version in _notes
. The only things that are
ignored is the contents of the metadata. If you want absolutely change the
metadata you can:
- Use
share --file <filepath>
directly - Use
--u
to force update all file - Continue to work on the file before pushing it.
- Add a newline with
$~$
or<br>
(it will be not converted and displayed on page / obsidian so...) - Manually delete the file
- Add or edit the metadata keys (unless
date
/title
/created
/update
/link
).
:warning: In case you have two files with the same name but :
- In different folder
- With different sharing statut The script will bug because I don't check folder (It's volontary). In this unique case, you need to rename one of the files.
Options
Share all
By adding, in the yaml of your file, the key share: true
, you allow the script to publish the file. In fact, the script will read all the files in your vault before selecting the ones meeting the condition.
By default, the script will check the difference between line (cf checking difference), and convert only the file with difference. You can use --u
to force update.
Share only a file
The file to be shared does not need to contain share: true
in its YAML.
How it works
The script :
- Moves file (with
share: true
frontmatter or specific file) in the_notes
folder - Moves image in
assets/img
and convert (with alt support) - Converts highlight (
==mark==
to[[mark::highlight]]
) - Converts "normal" writing to GFM markdown (adding
\n
each\n
) - Supports non existant file (adding a css for that 😉)
- Supports image flags css (Lithou snippet 🙏)
- Support normal and external files (convert "normal markdown link" to "wikilinks")
- Edit link to support transluction (if not
embed: False
) - Remove block id (no support)
- Add CSS settings for inline tags (no link support) ; Tags are : class = .hash ; id = #tag_name (so you can style each tags you use)
- Frontmatter : Update the date. If there is already a
date
key, save it tocreated
and updatedate
. - Frontmatter : In absence of title, add the file's title.
- Copy the link to your clipboard if one file is edited.
- ⭐ Admonition convertion to "callout inspired notion"
- Update the frontmatter in the original file, adding the link and change
share
to true if one file is shared.
Finally, the plugin will add, commit and push if supported.
Note : The clipboard maybe not work in your configuration. I have (and can) only test the script on IOS and Windows, so I use pyperclip
and pasteboard
to do that. If you are on MacOS, Linux, Android, please, check your configuration on your python and open an issue if it doesn't work.
Note : I can't testing on these 3 OS, so I can't create a clipboard option on my own.
Custom CSS
You can add CSS using the file (custom.css)[/assets/css/custom.css]. The plugin Markdown Attribute allow to use the creation of inline css. Some information about this :
- You need to add
:
after the first{
- The inline IAL work only if there is stylized markdown. In absence, the text will be bolded.
- It won't work with highlight (removed automatically by the script)
:warning: As I use CodeMirror Options and Contextual Typography, I warn you : the use of #tags
to stylize the text before it doesn't work with my build. So, as an option to don't have a random tag in a text, you can use custom.css
to remove it with display: none
(you can have an example with #left
).
Frontmatter settings
share: true
: Share the fileembed: false
: remove the transluction (convert to normal wikilinks)update: false
: Don't update the file at all.current: false
: Don't update the dateprivate: true
: Use the_private
folder collection instead of the_notes
collection.
Admonition
As admonition is very tricky, I choose to convert all admonition to a "callout Notion". The script will :
- Remove codeblock for admonition codeblocks
- Convert
```ad-```
to!!!ad-
- Bold title and add a IAL
{: .title}
JavaScript will niced all things.
⚠ As always with markdown, you will see some problem with new paragraph inside admonition. You can use $~$
to fake line. The script will automatically add this.
Also, you can add emoji on title to add some nice formatting.
IOS Shortcuts
:warning: DEPRECIATED BECAUSE I MOVE THE SCRIPT ! NEED TO BE UPDATED DONT USE IT PLEASE
IOS
To use the shortcuts, you need :
The main shortcut is on RoutineHub (more pratical for version update) : share one file
(it's equivalent to share <filepath>
)
There is another shortcuts to "share all" files : Share all true file in vault
(it's equivalent to share
without arguments)
Note : You first need to clone the repo with Working Copy and install all requirements.
To use the shortcuts, you need :
- a-shell (Free)
- Working Copy
Before running the shortcuts, you need to install all requirements, aka :
jump <vault>
cd script
pip install -r requirements.txt
For the moment I can't create a shortcuts to share only one file BUT ! You can using a-shell
as you do in a normal terminal, aka :
jump <vault>
python3 <vault-path>/script/sharing.py <file>
You could also create an alias for sharing using ~/.profile
:
alias share='python3 <git-folder>/script/sharing.py'
Obsidian
→ Please use Wikilinks with "short links" (I BEG YOU) You can integrate the script within obsidian using the nice plugin Obsidian ShellCommands.
You could create two commands :
share all
:python3 path/to/your/script/sharing.py
share one
:python3 path/to/your/script/sharing.py --f {{file_path:absolute}}
You can use :
- Customizable Sidebar
- Obsidian Customizable Menu To have a button to share your file directly in Obsidian !
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.