From bbefbc5dd202ca299e1760f6934ace79ba320499 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9o=20Marchal?= Date: Sun, 7 Apr 2024 23:07:00 +0200 Subject: [PATCH] Added usage --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6555970..8fcca6e 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,10 @@ For my Japanese Grammar (JPG) project, I have created a style for explanation on ## convert-usage.py -In my Quartz rendering of my markdown data, I want this kind of data to be in a callout. However, it is not possible to combine HTML and Markdown in Obsidian. For that purpose, this script encapsulates it directly in HTML. To make it both compatible in Obsidian and Quartz, and to be still easy to write, it's done with this python script. This is probably super specific and will not be of use for anybody except me! \ No newline at end of file +In my Quartz rendering of my markdown data, I want this kind of data to be in a callout. However, it is not possible to combine HTML and Markdown in Obsidian. For that purpose, this script encapsulates it directly in HTML. To make it both compatible in Obsidian and Quartz, and to be still easy to write, it's done with this python script. This is probably super specific and will not be of use for anybody except me! + +## Usage + +Usage: `python3 convert-usage.py [root folder]` + +Note: Please be careful, this software applies modifications recursively! \ No newline at end of file