mirror of https://github.com/laurent22/joplin.git
436 lines
18 KiB
HTML
436 lines
18 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
|
||
<!--
|
||
|
||
!!! WARNING !!!
|
||
|
||
This file was auto-generated from readme/spec/interop_with_frontmatter.md and any manual change
|
||
made to it will be overwritten. To make a change to this file please modify
|
||
the source Markdown file:
|
||
|
||
https://github.com/laurent22/joplin/blob/dev/readme/spec/interop_with_frontmatter.md
|
||
|
||
-->
|
||
|
||
<head>
|
||
<!-- Donate button A/B testing -->
|
||
|
||
<!--
|
||
<script async src="https://www.googleoptimize.com/optimize.js?id=OPT-PW3ZPK3"></script>
|
||
--> <meta
|
||
charset="utf-8"
|
||
http-equiv="X-UA-Compatible"
|
||
content="IE=edge,chrome=1"
|
||
/>
|
||
<link rel="icon" href="/images/favicon.png" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
<meta name="theme-color" content="#000000" />
|
||
<meta name="description" content="Joplin, the open source note-taking application" />
|
||
<link
|
||
rel="stylesheet"
|
||
href="/css/bootstrap5.0.2.min.css"
|
||
as="style"
|
||
/>
|
||
<link rel="stylesheet" href="/css/fontawesome-all.min.css?h=ecd507b3125edc4d2a03aa6ae5d07da9">
|
||
<link
|
||
href="https://fonts.googleapis.com/css2?family=Montserrat:wght@400;500;600;700&display=swap"
|
||
rel="stylesheet"
|
||
as="style"
|
||
media="all"
|
||
onload="this.media='all'; this.onload = null"
|
||
/>
|
||
<link rel="stylesheet" href="/css/site.css?h=7ac82e1f40a384f69c644263acc99fc8" as="style" />
|
||
<title>Markdown with Front Matter Exporter/Importer | Joplin</title>
|
||
|
||
<script
|
||
src="/js/jquery-3.6.0.min.js"
|
||
rel="preload"
|
||
as="script"
|
||
></script>
|
||
</head>
|
||
<body class="website-env-prod">
|
||
<div class="container-fluid generic-template -page" id="main-container">
|
||
|
||
<div class=" navbar-main white-bg" id="nav-section">
|
||
<div class="container">
|
||
<div class="row">
|
||
<div class="col-3">
|
||
<a href="/">
|
||
<img
|
||
src="/images/logo-text-blue.svg"
|
||
alt=""
|
||
id="top-logo"
|
||
width="180"
|
||
/>
|
||
</a>
|
||
</div>
|
||
<div class="col-9 text-right d-none d-md-block">
|
||
<a href="/help/" class="fw500">Help</a>
|
||
<a href="https://discourse.joplinapp.org/" class="fw500">Forum</a>
|
||
<a href="/plans/" class="button-link btn-trans plans-button">Joplin Cloud</a><a class="button-link btn-blue sponsor-button" href="/donate">
|
||
<i class="fas fa-heart heart-full"></i><i class="far fa-heart heart-line"></i> Support us
|
||
</a> </div>
|
||
<div class="col-9 text-right d-block d-md-none navbar-mobile-content">
|
||
<a class="button-link btn-blue sponsor-button" href="/donate">
|
||
<i class="fas fa-heart heart-full"></i><i class="far fa-heart heart-line"></i> Support us
|
||
</a>
|
||
<span class="pointer"
|
||
><img
|
||
src="/images/mobile-menu-black-open-icon.png"
|
||
id="open-menu-mobile"
|
||
alt=""
|
||
/></span>
|
||
|
||
|
||
<div id="menu-mobile">
|
||
<div>
|
||
<div class="text-right">
|
||
<img
|
||
src="/images/close-icon.png"
|
||
alt=""
|
||
class="pointer"
|
||
id="close-menu-mobile"
|
||
/>
|
||
</div>
|
||
|
||
<div class="text-center menu-mobile-top">
|
||
<a href="https://discourse.joplinapp.org/" class="fw500 mobile-menu-link">Forum</a>
|
||
<a href="/help/" class="fw500 mobile-menu-link">Help</a>
|
||
</div>
|
||
|
||
<div class="menu-mobile-buttons">
|
||
<a href="/plans/" class="button-link btn-trans plans-button">Joplin Cloud</a><a class="button-link btn-blue sponsor-button" href="/donate">
|
||
<i class="fas fa-heart heart-full"></i><i class="far fa-heart heart-line"></i> Support us
|
||
</a> </div>
|
||
</div>
|
||
|
||
<div id="toc-mobile"><div><ul>
|
||
<li>
|
||
<p>Applications</p>
|
||
<ul>
|
||
<li><a href="/desktop/">Desktop application</a></li>
|
||
<li><a href="/mobile/">Mobile applications</a></li>
|
||
<li><a href="/terminal/">Terminal application</a></li>
|
||
<li><a href="/clipper/">Web Clipper</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Support</p>
|
||
<ul>
|
||
<li><a href="https://discourse.joplinapp.org">Joplin Forum</a></li>
|
||
<li><a href="/markdown/">Markdown Guide</a></li>
|
||
<li><a href="/e2ee/">How to enable end-to-end encryption</a></li>
|
||
<li><a href="/conflict/">What is a conflict?</a></li>
|
||
<li><a href="/debugging/">How to enable debug mode</a></li>
|
||
<li><a href="/rich_text_editor/">About the Rich Text editor limitations</a></li>
|
||
<li><a href="/external_links/">External links</a></li>
|
||
<li><a href="/faq/">FAQ</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Joplin Cloud</p>
|
||
<ul>
|
||
<li><a href="/share_notebook/">Sharing a notebook</a></li>
|
||
<li><a href="/publish_note/">Publishing a note</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Joplin API - Get Started</p>
|
||
<ul>
|
||
<li><a href="/api/overview/">Joplin API Overview</a></li>
|
||
<li><a href="/api/get_started/plugins/">Plugin development</a></li>
|
||
<li><a href="/api/tutorials/toc_plugin/">Plugin tutorial</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Joplin API - References</p>
|
||
<ul>
|
||
<li><a href="https://joplinapp.org/api/references/plugin_api/classes/joplin.html">Plugin API</a></li>
|
||
<li><a href="/api/references/rest_api/">Data API</a></li>
|
||
<li><a href="/api/references/plugin_manifest/">Plugin manifest</a></li>
|
||
<li><a href="/api/references/plugin_loading_rules/">Plugin loading rules</a></li>
|
||
<li><a href="/api/references/plugin_theming/">Plugin theming</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Development</p>
|
||
<ul>
|
||
<li><a href="https://github.com/laurent22/joplin/blob/dev/BUILD.md">How to build the apps</a></li>
|
||
<li><a href="/spec/e2ee/">End-to-end encryption spec</a></li>
|
||
<li><a href="/spec/history/">Note History spec</a></li>
|
||
<li><a href="/spec/sync_lock/">Sync Lock spec</a></li>
|
||
<li><a href="/spec/plugins/">Plugin Architecture spec</a></li>
|
||
<li><a href="/spec/search_sorting/">Search Sorting spec</a></li>
|
||
<li><a href="/spec/server_file_url_format/">Server: File URL Format</a></li>
|
||
<li><a href="/spec/server_delta_sync/">Server: Delta Sync</a></li>
|
||
<li><a href="/spec/server_sharing/">Server: Sharing</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Google Summer of Code 2021</p>
|
||
<ul>
|
||
<li><a href="/gsoc2021/index/">Google Summer of Code 2021</a></li>
|
||
<li><a href="/gsoc2021/pull_request_guidelines/">How to submit a GSoC pull request</a></li>
|
||
<li><a href="/gsoc2021/ideas/">Project Ideas</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>About</p>
|
||
<ul>
|
||
<li><a href="/changelog/">Changelog (Desktop App)</a></li>
|
||
<li><a href="/changelog_cli/">Changelog (CLI App)</a></li>
|
||
<li><a href="/changelog_server/">Changelog (Server)</a></li>
|
||
<li><a href="/stats/">Stats</a></li>
|
||
<li><a href="/donate/">Donate</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div></div>
|
||
|
||
<div>
|
||
<p class="light-blue mobile-menu-link-bottom text-center">
|
||
Copyright © 2016-2021 Laurent Cozic
|
||
<br/>
|
||
<a href="/privacy/" class="fw500">Privacy Policy</a>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="help-page-container page-interop_with_frontmatter">
|
||
<div class="container">
|
||
<div class="row content-wrapper">
|
||
<div id="toc"><div><ul>
|
||
<li>
|
||
<p>Applications</p>
|
||
<ul>
|
||
<li><a href="/desktop/">Desktop application</a></li>
|
||
<li><a href="/mobile/">Mobile applications</a></li>
|
||
<li><a href="/terminal/">Terminal application</a></li>
|
||
<li><a href="/clipper/">Web Clipper</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Support</p>
|
||
<ul>
|
||
<li><a href="https://discourse.joplinapp.org">Joplin Forum</a></li>
|
||
<li><a href="/markdown/">Markdown Guide</a></li>
|
||
<li><a href="/e2ee/">How to enable end-to-end encryption</a></li>
|
||
<li><a href="/conflict/">What is a conflict?</a></li>
|
||
<li><a href="/debugging/">How to enable debug mode</a></li>
|
||
<li><a href="/rich_text_editor/">About the Rich Text editor limitations</a></li>
|
||
<li><a href="/external_links/">External links</a></li>
|
||
<li><a href="/faq/">FAQ</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Joplin Cloud</p>
|
||
<ul>
|
||
<li><a href="/share_notebook/">Sharing a notebook</a></li>
|
||
<li><a href="/publish_note/">Publishing a note</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Joplin API - Get Started</p>
|
||
<ul>
|
||
<li><a href="/api/overview/">Joplin API Overview</a></li>
|
||
<li><a href="/api/get_started/plugins/">Plugin development</a></li>
|
||
<li><a href="/api/tutorials/toc_plugin/">Plugin tutorial</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Joplin API - References</p>
|
||
<ul>
|
||
<li><a href="https://joplinapp.org/api/references/plugin_api/classes/joplin.html">Plugin API</a></li>
|
||
<li><a href="/api/references/rest_api/">Data API</a></li>
|
||
<li><a href="/api/references/plugin_manifest/">Plugin manifest</a></li>
|
||
<li><a href="/api/references/plugin_loading_rules/">Plugin loading rules</a></li>
|
||
<li><a href="/api/references/plugin_theming/">Plugin theming</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Development</p>
|
||
<ul>
|
||
<li><a href="https://github.com/laurent22/joplin/blob/dev/BUILD.md">How to build the apps</a></li>
|
||
<li><a href="/spec/e2ee/">End-to-end encryption spec</a></li>
|
||
<li><a href="/spec/history/">Note History spec</a></li>
|
||
<li><a href="/spec/sync_lock/">Sync Lock spec</a></li>
|
||
<li><a href="/spec/plugins/">Plugin Architecture spec</a></li>
|
||
<li><a href="/spec/search_sorting/">Search Sorting spec</a></li>
|
||
<li><a href="/spec/server_file_url_format/">Server: File URL Format</a></li>
|
||
<li><a href="/spec/server_delta_sync/">Server: Delta Sync</a></li>
|
||
<li><a href="/spec/server_sharing/">Server: Sharing</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>Google Summer of Code 2021</p>
|
||
<ul>
|
||
<li><a href="/gsoc2021/index/">Google Summer of Code 2021</a></li>
|
||
<li><a href="/gsoc2021/pull_request_guidelines/">How to submit a GSoC pull request</a></li>
|
||
<li><a href="/gsoc2021/ideas/">Project Ideas</a></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p>About</p>
|
||
<ul>
|
||
<li><a href="/changelog/">Changelog (Desktop App)</a></li>
|
||
<li><a href="/changelog_cli/">Changelog (CLI App)</a></li>
|
||
<li><a href="/changelog_server/">Changelog (Server)</a></li>
|
||
<li><a href="/stats/">Stats</a></li>
|
||
<li><a href="/donate/">Donate</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div></div>
|
||
|
||
<div class="main-content">
|
||
<div class="alert alert-danger alert-env-dev" role="alert">
|
||
Running in prod mode!
|
||
</div>
|
||
<div class="donate-links">
|
||
<p><a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=E8JMYD2LQ8MMA&lc=GB&item_name=Joplin+Development&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted"><img src="https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/badges/Donate-PayPal-green.svg" alt="Donate using PayPal"></a> <a href="https://github.com/sponsors/laurent22/"><img src="https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/badges/GitHub-Badge.svg" alt="Sponsor on GitHub"></a> <a href="https://www.patreon.com/joplin"><img src="https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/badges/Patreon-Badge.svg" alt="Become a patron"></a> <a href="https://joplinapp.org/donate/#donations"><img src="https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/WebsiteAssets/images/badges/Donate-IBAN.svg" alt="Donate using IBAN"></a></p>
|
||
</div>
|
||
<h1>Markdown with Front Matter Exporter/Importer<a name="markdown-with-front-matter-exporter-importer" href="#markdown-with-front-matter-exporter-importer" class="heading-anchor">🔗</a></h1>
|
||
<p>This exporter/importer is built around the MD exporter/importer. It functions identically, but includes a block of YAML front matter that contains note metadata.</p>
|
||
<p>YAML front matter is represented simply as a block of YAML between <code>---</code> delimiters. An illustrative example can be seen below.</p>
|
||
<pre><code>---
|
||
title: Joplin Interop
|
||
created: 1970-01-01 00:00Z
|
||
tags:
|
||
- export
|
||
- import
|
||
---
|
||
</code></pre>
|
||
<h2>Supported Metadata Fields<a name="supported-metadata-fields" href="#supported-metadata-fields" class="heading-anchor">🔗</a></h2>
|
||
<p>All of the below fields are supported by both the exporter and the importer.</p>
|
||
<ul>
|
||
<li><code>title</code>: Title of the note</li>
|
||
<li><code>updated</code>: Time of last not update (corresponds to <code>user_updated_time</code>)</li>
|
||
<li><code>created</code>: Creation time of note (corresponds to <code>user_created_time</code>)</li>
|
||
<li><code>source</code>: The source URL for a note that comes from the web clipper</li>
|
||
<li><code>author</code>: Author's name</li>
|
||
<li><code>latitude</code>: Latitude where note was created</li>
|
||
<li><code>longitude</code>: Longitude where note was created</li>
|
||
<li><code>altitude</code>: Altitude where note was created</li>
|
||
<li><code>completed?</code>: Exists if the note is a todo, indicates if the todo is completed</li>
|
||
<li><code>due</code>: Exists if the note is a todo, due date (alarm time) of note</li>
|
||
<li><code>tags</code>: List of all associated tag names</li>
|
||
</ul>
|
||
<h3>Exporter<a name="exporter" href="#exporter" class="heading-anchor">🔗</a></h3>
|
||
<p>The exporter will export all the above fields that hold values in the database. So <code>due</code> and <code>completed?</code> will only be included for "todo" notesm <code>tags</code> will only exist for notes that include tags, etc.</p>
|
||
<h3>Importer<a name="importer" href="#importer" class="heading-anchor">🔗</a></h3>
|
||
<p>The importer will import the metadata corresponding to all of the above fields. Missing data will be filled in as if the note was just created. Extra fields will be ignored.</p>
|
||
<p>There are other tools that use similar YAML front matter blocks, notably <a href="https://pandoc.org/MANUAL.html#extension-yaml_metadata_block">pandoc</a> and <a href="https://github.com/hao203/rmarkdown-YAML">r-markdown</a>. The importer attempts to provide compatibility with these formats where possible.</p>
|
||
<h2>Dates<a name="dates" href="#dates" class="heading-anchor">🔗</a></h2>
|
||
<h3>Exporter<a name="exporter-1" href="#exporter-1" class="heading-anchor">🔗</a></h3>
|
||
<p>All dates are exported in the ISO 8601 format (substituting the 'T' for a space based on RFC 3339 for readability) in the UTC time zone.</p>
|
||
<p>e.g. <code>1970-01-01 00:00:00Z</code></p>
|
||
<h3>Importer<a name="importer-1" href="#importer-1" class="heading-anchor">🔗</a></h3>
|
||
<p>The importer is more flexible with dates. It will handle ISO 8601 dates with or without a timezone, if no timezone is specified, local time will be used. If there is a timezone specified (Z notation or +00:00 notation) that timezone will be used. If the format is not ISO 8601, the importer will attempt to read based on the users configured date and time preferences (Tools -> Options -> General or Joplin -> Preferences -> General). The importer will fallback on the Javascript <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date">Date</a> functionality if the format can not be read.</p>
|
||
<h2>Examples<a name="examples" href="#examples" class="heading-anchor">🔗</a></h2>
|
||
<p>Below are a collection of examples that represent valid notes that may have been exported by the exporter, and can be imported by the importer.</p>
|
||
<pre><code>---
|
||
title: Frogs
|
||
source: https://en.wikipedia.org/wiki/Frog
|
||
created: 2021-05-01 16:40:00Z
|
||
updated: 2021-05-01 16:40:00Z
|
||
tags:
|
||
- Reference
|
||
- Cool
|
||
---
|
||
|
||
This article is about the group of amphibians. For other uses, see [Frog (disambiguation)](https://en.wikipedia.org/wiki/Frog_%28disambiguation%29 "Frog (disambiguation)").
|
||
...
|
||
</code></pre>
|
||
<pre><code>---
|
||
title: Take Home Quiz
|
||
created: 2021-05-01 16:40:00Z
|
||
updated: 2021-06-17 23:59:00Z
|
||
tags:
|
||
- school
|
||
- math
|
||
- homework
|
||
completed?: no
|
||
due: 2021-06-18 08:00:00Z
|
||
---
|
||
|
||
**Prove or give a counter-example of the following statement:**
|
||
|
||
> In three space dimensions and time, given an initial velocity field, there exists a vector velocity and a scalar pressure field, which are both smooth and globally defined, that solve the Navier–Stokes equations.
|
||
</code></pre>
|
||
<pre><code>---
|
||
title: All Fields
|
||
updated: 2019-05-01 16:54:00Z
|
||
created: 2019-05-01 16:54:00Z
|
||
source: https://joplinapp.org
|
||
author: Joplin
|
||
latitude: 37.084021
|
||
longitude: -94.51350100
|
||
altitude: 0.0000
|
||
completed?: no
|
||
due: 2021-08-22 00:00:00Z
|
||
tags:
|
||
- joplin
|
||
- note
|
||
- pencil
|
||
---
|
||
|
||
All of this metadata is available to be imported/exported.
|
||
</code></pre>
|
||
|
||
<div class="bottom-links">
|
||
<a href="https://github.com/laurent22/joplin/blob/dev/readme/spec/interop_with_frontmatter.md">
|
||
<i class="fab fa-github"></i> Improve this doc
|
||
</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer class="darkblue-bg">
|
||
<div class="container">
|
||
<div class="row">
|
||
<div class="col-12 col-md-12 social-links">
|
||
<a href="https://twitter.com/joplinapp" title="Joplin Twitter feed"><i class="fab fa-twitter"></i></a>
|
||
<a href="https://mastodon.social/@joplinapp" title="Joplin Mastodon feed"><i class="fab fa-mastodon"></i></a>
|
||
<a href="https://www.patreon.com/joplin" title="Joplin Patreon"><i class="fab fa-patreon"></i></a>
|
||
<a href="https://discordapp.com/invite/d2HMPwE" title="Joplin Discord chat"><i class="fab fa-discord"></i></a>
|
||
<a href="https://www.reddit.com/r/joplinapp/" title="Joplin Subreddit"><i class="fab fa-reddit"></i></a>
|
||
<a href="https://github.com/laurent22/joplin/" title="Joplin GitHub repository"><i class="fab fa-github"></i></a>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="row bottom-links-row">
|
||
<div class="col-12 col-md-6">
|
||
<p class="text-center-sm">Copyright © 2016-2021 Laurent Cozic</p>
|
||
</div>
|
||
<div class="col-12 col-md-6">
|
||
<p class="text-right text-center-sm right-links">
|
||
<span class="footer-right">
|
||
<a href="/privacy/">Privacy Policy</a>
|
||
</span>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer> </div>
|
||
|
||
<script src="/js/script.js?h=46b3b58d72c94591621551affbb8c6e3"></script>
|
||
|
||
<script>
|
||
if (window.location.hostname !== 'localhost') {
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||
ga('create', 'UA-103586105-1', 'auto');
|
||
ga('send', 'pageview');
|
||
}
|
||
</script> </body>
|
||
</html>
|