Giter Club home page Giter Club logo

joplin-export-backup's Introduction

joplin-export-backup

A Python utility that exports and backup notes as Markdown format in Joplin to a Cloud Storage bucket of Google Cloud.

Note

The utility changes the markdown notes. Specifically, two things are changed:

  1. the local links to images and other resources are changed because of how Joplin stores the resources internally. For example, if you insert an image test.png to a note in Joplin, then Joplin would create a link ![test.png](:/<an internal ID generated by Joplin) within your notes.
    This script modify the link to remove :/ such that the notes can be used within any local filesystem.
  2. the spaces within the filename are changed to underscores

Therefore, the notes exported by this utility cannot be re-imported to Joplin.
If you want to backup the notes but re-import them to Joplin, use the built-in backup or export functions instead.

How to use the utility

  1. In Joplin, open Tools -> Options -> Web Clipper
  2. Click "Enable Web Clipper Service"
  3. Click "Copy Token" to get the Joplin API token
  4. create cred.py in the cloned repository, its content should look like:
JOPLIN_TOKEN = "<the API token that you copied>"
  1. run py main.py <name of the notebook that you want to backup>
    For example, if we want to backup all notes within the notebook "Testing Testing", then run:
    py main.py "Testing Testing" (remember the quotes)

Output

The utility creates a folder with the name same as the name of the notebook.
Inside the folder, all the notes and the resources (e.g., images) within the notes are exported to the folder.

TODO

  • rewrite the utility as a Joplin plugin
  • rewrite the utility to backup the whole Joplin

joplin-export-backup's People

Contributors

hsutungyu avatar

Watchers

 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.