Skip to content

Latest commit

 

History

History
87 lines (69 loc) · 4.97 KB

README.md

File metadata and controls

87 lines (69 loc) · 4.97 KB
Raw

logo

Yarle is the ultimate converter of Evernote notes to Markdown.

Features:

Yarle can convert:

  • 📝 Any text
  • 📝 All metadata: original creation time, last modification time, tags, GPS location, notebook name, source URL
  • 🔗 External links
  • 🔗 Internal links among Evernote notes
  • 💻 Codeblocks
  • 🖼️ Inline Images
  • 📎 Attachments
  • 📄 Webclips

Works with:

  • 📓 single enex file (one notebook exported from Evernote)
  • 📚 or a folder of enex files supported (several notebooks exported and placed into the same folder locally)

Highly customizable:

  • 🚀 Creates Markdown files matching to user-defined templates, see Templates introduced. See How to use templates with YARLE for details.
  • 💡 Metadata support: Puts title, creation time, update time, tags, and latlong source, notebook, link to original html meta-information into md as metadata. (To set them, please set up a custom template)
  • 🔨 Updates md files' creation, access, and modification timestamps according to the notes' original create/update/modification time.
  • 🔨 Organizes all attachments into a _resources subfolder (to keep the notes' folder as simple as possible).

Prerequisite

No-install execution

Just open a terminal, specify config options in a config file (options detailed in Configuration) and type the following:

npx -p yarle-evernote-to-md@latest yarle --configFile <path_to_your_file e.g. ./config.json>

Configuration:

To configure Yarle, you must create a config file. By default it looks like this:

{
    "enexSource": "/absolute-path-of-your-enex-dir/test-template.enex",
    "templateFile": "/absolute-path-of-your-template-dir/sampleTemplate.tmpl",
    "outputDir": "/path-of-your-desired-output-folder",
    "isZettelkastenNeeded": false,
    "plainTextNotesOnly": false,
    "skipWebClips": false,
    "useHashTags": true,
    "outputFormat": "StandardMD",
    "skipEnexFileNameFromOutputPath": false,
    "haveEnexLevelResources": false,
    "monospaceIsCodeBlock": false,
    "keepMDCharactersOfENNotes": false,
    "nestedTags": {
      "separatorInEN": "_",
      "replaceSeparatorWith": "/",
      "replaceSpaceWith": "-"
   }
}

The following configurational properties are available: |

Property Name Property value Meaning
enexSource your enex file or the folder of your enex files specifies the exported Evernote notebook(s) as an absolute path
templateFile path of your custom template file if its not specified, a default template will be used
outputDir path to your output dir (absolute or relative) this is the main output dir where the extracted markdown files and the external resources, images, pdf-s are going to be created
isZettelkastenNeeded true or false puts Zettelkasten Id (based on time of creation) at the beginning of the file name
plaintextNotesOnly true or false skips any notes with attachments (e.g. notes containing pictures)
useHashTags true or false whether to add the pound sign in front of tags
outputFormat true or false generates internal file links and highlights in Obsidian-style: highlights are going to be bounded by == instead of ` characters, file links are going to be as follows: ![[file-name]] instead of ![file-name](file-name). Possible values: ObsidianMD to get Obsidian-style notes, StandardMD or skip it completely, if you prefer Standard Markdown format.
haveEnexLevelResources true or false stores note resources on global _resources folder per enex export if enabled
monospaceIsCodeBlock true or false if it's true then all deepest elements with monospace font style is recognized as Codeblocks
dateFormat  string ISO 8601 specification of the expected date format (e.g. YYYY-MM-DD)
keepMDCharactersOfENNotes true or false set it true, if you used Markdown format in your EN notes
nestedTags it's a complex property contains the following subitems: "separatorInEN", "replaceSeparatorWith" and "replaceSpaceWith"  separatorInEN stores the tag separator used in Evernote, replaceSeparatorWith is the string to what separatorInEN should be replaced to, and replaceSpaceWith is the string to what the space character should be replaced to in the tags. For example using the default settings a tag tag1_sub tag of tag1 is going to be converted to tag1/sub-tag-of-tag1
keepObsidianImageSize preserve an image's width and height in a format that is supported by Obsidian

Metadata settings can be set via the template.

Release notes