A quick way to convert obsidian markdown docs to markdown static pages
Project description
ObsiDown
Convert obsidian files into well linked markdowns!
Example use cases
- Export Obsidian subdirectories while maintaining the links in markdown format
- Make obsidian math Kramdown-compatible
- Use obsidian to write for Jekyll web pages.
How to use
Define a configuration file config.yaml
. In the repo it is provided one as example.
Install the poetry
dependencies and then you just need to run poetry run python -m obsidown --config path/to/config.yaml
Installation as a python package is still on todo!
Feedback
This project is a hobby project used to automate some things I use myself. Currently it is a early early project! If you need additional features or report some issues or need help, feel free to open a new issue.
Documentation
The quickest way to check what is the format of the config file is to see the pydantic from config.py
.
Here I will just outline it briefly.
sources
defines where to look for the input files.paths
: where to look for the md files?images
: where to look for the linked images?
output
defines where to write the exported files.base
: defines the base url for linkspath
: defines a subpath for the markdown filesimages
: defines a subpath for the image fiilesfilesystem
: where to write
pipeline
: defines the single operations possible on a markdown file.name
: the identifier of the operation, you should checkdispatch.py
for a list of the operations.options
: variable options of the single operation.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for obsidown-0.1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60708b046b7af6536d03808c6f2681151a702596dd569b860fbc6dec166639f4 |
|
MD5 | 21ae129754ecc60f1d6cc1e6c8016710 |
|
BLAKE2b-256 | 3ff62497aeda51441a750cd07372dd02695366bd619f05950edce23ab6854470 |