Coder Social home page Coder Social logo

simeonlukas / obsidian-kindle-export Goto Github PK

View Code? Open in Web Editor NEW
46.0 5.0 0.0 35.73 MB

A plugin which converts .md files from Obsidian to your Kindle/PocketBook

License: MIT License

TypeScript 28.17% JavaScript 71.82% CSS 0.01%
obsidian-plugin typescript kindle converter ebook paperless obsidian epub pocketbook

obsidian-kindle-export's Introduction

Project 2: obsidian-kindle-export

An Obsidian-plugin which sends your notes to your Kindle/PocketBook as .epub file

Work paperless

GitHub manifest version (path)

Introduction

I was using Calibre and Pandoc-Export plugin, but I was wondering about a short way to export your .md files in one command and add all embedded files. So you dont have to use a .pdf file. The plugin creates a Kindle: Export command, which sends all embedded images and .md files to a PHP backend (Host your own private PHP Backend!) which converts it to a .epub file and sends it via email to your Kindle/PocketBook. If you are not hosting on your own, you will send private data to my server. Please be aware of this. I won't save or read your data!

New open Backend:

https://md2epub.staneks.de/

To Do's:

  • Export images
  • Export embedded .md files
  • Export embedded .mp3 files (Pocketbook)
  • Obsidian cover for the books --> Due to the .epub format, the cover will not appear on the bookshelf
  • Table of contents
  • <div style="page-break-after: always;"></div> is working
  • %%Excludes%% are invisible
  • External links
  • External embedded images
  • Exclude metadata
  • Become a Communityplugin 🎉
  • Create workaround for other embedded files
  • Add ==highlighting==
  • .epub export
  • Footnotes
  • Foldercover or filecover
  • .html export (Archive)
  • .pdf export (would be nice for IOS & Android)

Extra features (no kindle data needed)

  • .md export (mergedown)
    • Audio export
    • Video export
    • define own exportpath

Just try it!

For embedding local images, please use the following format: ![[image.jpg]]

Fill in your data for your Kindle/PocketBook and your mailadress. Read your notes on your Kindle/PocketBook.

Mergedown: Combine all your embedded images and .md files in one .md file.

If you have problems with the plugin, please let me know.

© Simeon Stanek

obsidian-kindle-export's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

obsidian-kindle-export's Issues

Please help!

Thanks for you share!
And I try to use you Plugin that I have some problem.
I have not my own Backend , and use the (https://staneks.de/apps/md2mobi/) as Backend
My kindle get file but it looks a certain amout of odd!
There some picture
6dc1625ded08e65145ce35bd5c52c2e
Snipaste_2022-03-14_09-57-41
Snipaste_2022-03-14_09-58-02

Mergedown crashes when there is a circular reference

Mergedown command expands embedded markdown file. So when there is a circular reference (written in the embedding format), it seems to expand infinitely.

Here is the minimum example (suppose that the filename is self.md):
![[self.md]]

Page breaks before headers

First off, thank you for this amazing plugin and the backend. I was able to set everything up and it works like a charm.

I have a question about the headers - there's a page break before every header in my file. As a result, I have dozens of page in situations where the whole content could be just a few pages. Is this intentional? If yes, how can I customize it?

I am getting SMTP connect Fail Error

12-10 Wednesday 01

I have PHP 8 installed.

I am getting an "SMTP Connect Fail Error". I am using port 587. Gmail as SMTP Provider ("smtp.gmail.com")

nb: I have XAMPP installed. Is it necessary to install PHPmailer separately for this plugin to work?

Private API deprecation

Hello! We noticed that you're using an undocumented Obsidian function in your plugin that we'll likely be changing soon. I highly suggest making a replacement for it from public API instead of relying on it!

The API you were using is fileManager.getAllLinkResolutions().

// Old
let AllLinks = this.app.fileManager.getAllLinkResolutions();
for (let i = 0; i < AllLinks.length; i++) {
	if (AllLinks[i].sourceFile.path == dokument.path) {
		links.push(AllLinks[i]);
	}
}
// New
this.app.metadataCache.iterateReferences((sourcePath: string, reference: ReferenceCache) => {
	if (sourcePath == dokument.path) {
		links.push(reference);
	}
});

Bug: footnote can't export to kindle

Hi ,friend.
Can you try to export md file to kindle with footnote?
I use it and can't display right on my kindle.
Please check it out if you have free time.

Mergedown with more customization

Firstly, your feature for mergedown was something that a lot of people have been wanting including me so it was surprise to see you adlready had it as part of your plugin.

It's such a sought-after feature in my opinion that it could be its own plugin with extra options such as the ability to remove any or some markdown notations such as tags or even [[ ]] to turn the newly merged note into a single plain note. And maybe option to decide on how to treat embedded note titles.

Your current implementation is already so good wish I had known of it sooner. People who use Obsidian for long form writing need this plugin just for the merge feature. So thank you.

tags as headers problem

I have #tags in my notes and when I export them, they convert to # HEADERS and because of that, it splits the whole chapter into pieces.

There was a problem with the document(s) that you sent to Kindle

Dear Simeon,

I can't send files to kindle anymore, I get the following error message:

Dear Kindle Customer,

The following document, sent by you at 16:16 Uhr, am Sonntag, 21. August 2022 MESZ, could not be delivered to the address you specified:

  • test for kindle.epub

I'm using your plugin with default settings, and with your backend.
Are there any issues with the recent change from mobi to epub?
Thanks a lot for your great plugin, it has been super helpful to me :-)

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.