Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 770 Bytes

developer_docs.md

File metadata and controls

23 lines (18 loc) · 770 Bytes

Developer documentation

Install custom code

These steps describe how to install the requirements and use obsidianhtml from the code, instead of installing it as a package. This way you can quickly test changes.

# Get the code
# Note that the master branch is work in progress! Code might be broken. 
# Move into a release branch if you want fully tested code instead.
git clone [email protected]:obsidian-html/obsidian-html.git

# Move into folder
cd obsidian-html

# Install all the dependencies of the package, but not the package itself.
# You only need to do this once.
pip install .

# Run ObsidianHtml from code (so not via the package)
python -m obsidianhtml -i /path/to/config.yml

Architecture

Architecture & Code standards