Inkdrop plugin

This note was commited to Gitlab, using a plugin for Inkdrop!

Features

Done

• Pushing new or updating existing files
• Remove a note
• Show a message after a command runs

WIP

Backlog

• Config for metadata Category
• Keyboard shortcuts
• Handle pushing notes with images
• Show message if minimal config is missing
• Handle exceptions
• Check for special chars on Book name, Note title or body.

Issues

• If the note's title changes, it wil no longer match the file name on the repo and will be pushed as a new file, instead of updating the previous one.
• This plugin cannot be hosted on Gitlab because Inkdrop relies on Github. Could mirror the repo, but meh. The irony...

Config

• gitlabApiToken (no default value, required)
• projectId (no default value, required)
• basePath (defaults to blank)
• skipNoteRootDir (defaults to true)
• addMetadata (defaults to true)
• branch (defaults to master)

basePath will be added to the file's path on the repo. eg. with basePath=content, all files will be commited under /content on the repo.

skipNoteRootDir will skip the note's root Book. eg. A note stored on the path FirstBook>Sub Notebook>My Note, will be pushed to {basePath}/sub_notebook/my_note.md

addMetadata will add metadata (Markdown syntax) to the head of the note.

Title: Note title
Date: 2010-12-03
Modified: 2010-12-05
Category: posts
Tags: inkdrop, note

The contents of the note on Inkdrop

Note: Using basePath, skipNoteRootDir and addMetadata together, allows me to push Inkdrop notes as Markdown files to the /content folder on this site's repo. As it's built using Pelican (Static Site Generator, Powered by Python), with Gitlab's CI/CD, pushing triggers the regeneration and deploy of the site.