|
|
@@ -0,0 +1,25 @@
|
|
|
+# Markdown YAML field name converter
|
|
|
+
|
|
|
+This script is a tool to change the YAML field name to new name to allow dataview plug-in of Obsidian to read.
|
|
|
+
|
|
|
+
|
|
|
+## Change and background
|
|
|
+The change rules are
|
|
|
+
|
|
|
+- `data created` to `data-created` (from Obsidian linter)
|
|
|
+- `data modified` to `data-modified` (from Obsidian linter)
|
|
|
+- `data updated` to `data-updated` (this is old field name from pretty plug-in)
|
|
|
+
|
|
|
+
|
|
|
+The reason of change is the Obsidian dataview plug-in cannot identify the field name with the white space. In its document, the field with white space will be change from `data created` to `date-created` transparently. However, the current version in my Obsidian, the plug-in cannot work correctly.
|
|
|
+
|
|
|
+
|
|
|
+## Usage
|
|
|
+
|
|
|
+The script will rewrite all markdown document with UTF-8 encording for these target field names.
|
|
|
+
|
|
|
+```
|
|
|
+markdown-field-converter --dir=<target document directory>
|
|
|
+```
|
|
|
+
|
|
|
+Please make try with small amount of documents and create backup before the change.
|
