GithubHelp home page GithubHelp logo

ryzenfromfire / obsidian-md-html-export Goto Github PK

View Code? Open in Web Editor NEW

This project forked from klalle/obsidiantohtmlconverter

0.0 0.0 0.0 75 KB

Python script for converting obsidian md-file to html (recursively adds all link/images to configurable depth)

Python 100.00%

obsidian-md-html-export's Introduction

obsidian-md-html-export

Adapted from the python script created by Klalle for exporting obsidian Markdown files. Can be exported to static (local) html (recursively adds all link/images), or to a folder of Markdown files that is ready to use as an Obsidian vault. This fork is more useful for the latter. I (RyzenFromFire) added support for limiting the depth of the recursion, because the original script basically tried to pull my whole vault, which didn't go well.

The script has 3 optional parameters:

  1. Export to HTML or not [Y/N]
    • N: Exports the chosen md-file to a new vault and bring all the images and linked md-files with it (recursively!)
      • Easily opened as a new vault in obsidian and everything just works!
    • Y: Exactly like above, but also create HTML files next to the MD files (with images and working links to other md.html files in vault)
      • The script puts an index.html-file in the root of the exported vault that is a direct link to your exported file.md.html for easy access
  2. Download external images to local vault [Y/N] (if export to HTML is chosen)
    • Y: downloads all the images
    • N: normal link to external image that downloads when viewed
  3. A maximum depth (default 5)

Run this script from the root of Obsidian vault.

usage: python3 exportMdFileToHtml.py <filename.md> <[y/n] [y/n]>

  • "<filename.md>" no filepath needed unless you have several files with same name

Only tested on Linux and Windows!

obsidian-md-html-export's People

Contributors

klalle avatar ryzenfromfire avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.