markdown builder and import API

Author: mProjectsCode

README.md

@@ -8,63 +8,65 @@ The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definiti
 **Note:** The Obsidian API is still in early alpha and is subject to change at any time!
 
 This sample plugin demonstrates some of the basic functionality the plugin API can do.
-- Adds a ribbon icon, which shows a Notice when clicked.
-- Adds a command "Open Sample Modal" which opens a Modal.
-- Adds a plugin setting tab to the settings page.
-- Registers a global click event and output 'click' to the console.
-- Registers a global interval which logs 'setInterval' to the console.
+
+-   Adds a ribbon icon, which shows a Notice when clicked.
+-   Adds a command "Open Sample Modal" which opens a Modal.
+-   Adds a plugin setting tab to the settings page.
+-   Registers a global click event and output 'click' to the console.
+-   Registers a global interval which logs 'setInterval' to the console.
 
 ## First time developing plugins?
 
 Quick starting guide for new plugin devs:
 
-- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
-- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
-- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
+-   Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
+-   Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
+-   Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
+-   Install NodeJS, then run `npm i` in the command line under your repo folder.
+-   Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
+-   Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
+-   Reload Obsidian to load the new version of your plugin.
+-   Enable plugin in settings window.
+-   For updates to the Obsidian API run `npm update` in the command line under your repo folder.
 
 ## Releasing new releases
 
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
-- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
-- Publish the release.
+-   Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
+-   Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
+-   Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
+-   Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
+-   Publish the release.
 
 > You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
 > The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
 
 ## Adding your plugin to the community plugin list
 
-- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
-- Publish an initial version.
-- Make sure you have a `README.md` file in the root of your repo.
-- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
+-   Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
+-   Publish an initial version.
+-   Make sure you have a `README.md` file in the root of your repo.
+-   Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
 
 ## How to use
 
-- Clone this repo.
-- `npm i` or `yarn` to install dependencies
-- `npm run dev` to start compilation in watch mode.
+-   Clone this repo.
+-   `npm i` or `yarn` to install dependencies
+-   `npm run dev` to start compilation in watch mode.
 
 ## Manually installing the plugin
 
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
+-   Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
 
 ## Improve code quality with eslint (optional)
-- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. 
-- To use eslint with this project, make sure to install eslint from terminal:
-  - `npm install -g eslint`
-- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by file and line number.
-- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
-  - `eslint .\src\`
+
+-   [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
+-   To use eslint with this project, make sure to install eslint from terminal:
+    -   `npm install -g eslint`
+-   To use eslint to analyze this project use this command:
+    -   `eslint main.ts`
+    -   eslint will then create a report with suggestions for code improvement by file and line number.
+-   If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
+    -   `eslint .\src\`
 
 ## Funding URL
 
@@ -74,19 +76,19 @@ The simple way is to set the `fundingUrl` field to your link in your `manifest.j
 
 ```json
 {
-    "fundingUrl": "https://buymeacoffee.com"
+	"fundingUrl": "https://buymeacoffee.com"
 }
 ```
 
 If you have multiple URLs, you can also do:
 
 ```json
 {
-    "fundingUrl": {
-        "Buy Me a Coffee": "https://buymeacoffee.com",
-        "GitHub Sponsor": "https://github.com/sponsors",
-        "Patreon": "https://www.patreon.com/"
-    }
+	"fundingUrl": {
+		"Buy Me a Coffee": "https://buymeacoffee.com",
+		"GitHub Sponsor": "https://github.com/sponsors",
+		"Patreon": "https://www.patreon.com/"
+	}
 }
 ```
 

esbuild.config.mjs

@@ -10,54 +10,49 @@ if you want to view the source, please visit the github repository of this plugi
 */
 `;
 
-const prod = process.argv[2] === 'production';
-
-esbuild
-	.build({
-		banner: {
-			js: banner,
-		},
-		entryPoints: ['src/main.ts'],
-		bundle: true,
-		external: [
-			'obsidian',
-			'electron',
-			'@codemirror/autocomplete',
-			'@codemirror/closebrackets',
-			'@codemirror/collab',
-			'@codemirror/commands',
-			'@codemirror/comment',
-			'@codemirror/fold',
-			'@codemirror/gutter',
-			'@codemirror/highlight',
-			'@codemirror/history',
-			'@codemirror/language',
-			'@codemirror/lint',
-			'@codemirror/matchbrackets',
-			'@codemirror/panel',
-			'@codemirror/rangeset',
-			'@codemirror/rectangular-selection',
-			'@codemirror/search',
-			'@codemirror/state',
-			'@codemirror/stream-parser',
-			'@codemirror/text',
-			'@codemirror/tooltip',
-			'@codemirror/view',
-			...builtins,
-		],
-		format: 'cjs',
-		watch: !prod,
-		target: 'es2018',
-		logLevel: 'info',
-		sourcemap: prod ? false : 'inline',
-		treeShaking: true,
-		outfile: 'main.js',
-		minify: true,
-		plugins: [
-			esbuildSvelte({
-				compilerOptions: { css: true },
-				preprocess: sveltePreprocess(),
-			}),
-		],
-	})
-	.catch(() => process.exit(1));
+await esbuild.build({
+	banner: {
+		js: banner,
+	},
+	entryPoints: ['src/main.ts'],
+	bundle: true,
+	external: [
+		'obsidian',
+		'electron',
+		'@codemirror/autocomplete',
+		'@codemirror/closebrackets',
+		'@codemirror/collab',
+		'@codemirror/commands',
+		'@codemirror/comment',
+		'@codemirror/fold',
+		'@codemirror/gutter',
+		'@codemirror/highlight',
+		'@codemirror/history',
+		'@codemirror/language',
+		'@codemirror/lint',
+		'@codemirror/matchbrackets',
+		'@codemirror/panel',
+		'@codemirror/rangeset',
+		'@codemirror/rectangular-selection',
+		'@codemirror/search',
+		'@codemirror/state',
+		'@codemirror/stream-parser',
+		'@codemirror/text',
+		'@codemirror/tooltip',
+		'@codemirror/view',
+		...builtins,
+	],
+	format: 'cjs',
+	target: 'es2018',
+	logLevel: 'info',
+	sourcemap: false,
+	treeShaking: true,
+	outfile: 'main.js',
+	minify: true,
+	plugins: [
+		esbuildSvelte({
+			compilerOptions: { css: true },
+			preprocess: sveltePreprocess(),
+		}),
+	],
+});

esbuild.dev.config.mjs

@@ -11,64 +11,61 @@ if you want to view the source, please visit the github repository of this plugi
 */
 `;
 
-const prod = process.argv[2] === 'production';
+const context = await esbuild.context({
+	banner: {
+		js: banner,
+	},
+	entryPoints: ['src/main.ts'],
+	bundle: true,
+	external: [
+		'obsidian',
+		'electron',
+		'@codemirror/autocomplete',
+		'@codemirror/closebrackets',
+		'@codemirror/collab',
+		'@codemirror/commands',
+		'@codemirror/comment',
+		'@codemirror/fold',
+		'@codemirror/gutter',
+		'@codemirror/highlight',
+		'@codemirror/history',
+		'@codemirror/language',
+		'@codemirror/lint',
+		'@codemirror/matchbrackets',
+		'@codemirror/panel',
+		'@codemirror/rangeset',
+		'@codemirror/rectangular-selection',
+		'@codemirror/search',
+		'@codemirror/state',
+		'@codemirror/stream-parser',
+		'@codemirror/text',
+		'@codemirror/tooltip',
+		'@codemirror/view',
+		...builtins,
+	],
+	format: 'cjs',
+	target: 'es2018',
+	logLevel: 'info',
+	sourcemap: 'inline',
+	treeShaking: true,
+	outdir: 'exampleVault/.obsidian/plugins/obsidian-js-engine-plugin/',
+	outbase: 'src',
+	plugins: [
+		copy([
+			{
+				from: './styles.css',
+				to: '',
+			},
+			{
+				from: './manifest.json',
+				to: '',
+			},
+		]),
+		esbuildSvelte({
+			compilerOptions: { css: true },
+			preprocess: sveltePreprocess(),
+		}),
+	],
+});
 
-esbuild
-	.build({
-		banner: {
-			js: banner,
-		},
-		entryPoints: ['src/main.ts'],
-		bundle: true,
-		external: [
-			'obsidian',
-			'electron',
-			'@codemirror/autocomplete',
-			'@codemirror/closebrackets',
-			'@codemirror/collab',
-			'@codemirror/commands',
-			'@codemirror/comment',
-			'@codemirror/fold',
-			'@codemirror/gutter',
-			'@codemirror/highlight',
-			'@codemirror/history',
-			'@codemirror/language',
-			'@codemirror/lint',
-			'@codemirror/matchbrackets',
-			'@codemirror/panel',
-			'@codemirror/rangeset',
-			'@codemirror/rectangular-selection',
-			'@codemirror/search',
-			'@codemirror/state',
-			'@codemirror/stream-parser',
-			'@codemirror/text',
-			'@codemirror/tooltip',
-			'@codemirror/view',
-			...builtins,
-		],
-		format: 'cjs',
-		watch: !prod,
-		target: 'es2016',
-		logLevel: 'info',
-		sourcemap: prod ? false : 'inline',
-		treeShaking: true,
-		outdir: 'exampleVault/.obsidian/plugins/obsidian-js-engine-plugin/',
-		outbase: 'src',
-		plugins: [
-			copy([
-				{
-					from: './styles.css',
-					to: '',
-				},
-				{
-					from: './manifest.json',
-					to: '',
-				},
-			]),
-			esbuildSvelte({
-				compilerOptions: { css: true },
-				preprocess: sveltePreprocess(),
-			})
-		],
-	})
-	.catch(() => process.exit(1));
+await context.watch();

exampleVault/Test.md

@@ -29,7 +29,23 @@ let blockquote = callout.createBlockQuote()
 blockquote.createHeading(5, "This is a block quote")
 blockquote.createParagraph("This is another test paragraph.")
 
+callout.createTable(["Column 1", "Column 2"], [
+	["data 1", "**data 2**"],
+	["data 3", "data 4"],
+]);
+
 return markdownBuilder
 ```
 
+# Import Test
+
+```js-engine
+let lib = await engine.importJs("lib.js");
+return lib.getGreeting();
+```
+
+# Async Tewst
 
+```js-engine
+return await engine.test()
+```

exampleVault/lib.js

@@ -0,0 +1,3 @@
+export function getGreeting() {
+	return "Hello!";
+}