{"id":17027331,"url":"https://github.com/mprojectscode/obsidian-js-engine-plugin","last_synced_at":"2025-04-06T03:06:33.796Z","repository":{"id":177424521,"uuid":"659885582","full_name":"mProjectsCode/obsidian-js-engine-plugin","owner":"mProjectsCode","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-22T16:57:47.000Z","size":814,"stargazers_count":118,"open_issues_count":6,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-30T02:04:47.776Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.moritzjung.dev/obsidian-js-engine-plugin-docs/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mProjectsCode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["mProjectsCode"]}},"created_at":"2023-06-28T19:23:53.000Z","updated_at":"2025-03-29T16:54:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"5987ec89-2cca-4436-af0e-1143422473dc","html_url":"https://github.com/mProjectsCode/obsidian-js-engine-plugin","commit_stats":{"total_commits":126,"total_committers":2,"mean_commits":63.0,"dds":0.007936507936507908,"last_synced_commit":"296bd00a107b99e418da24363f7318bb168218f0"},"previous_names":["mprojectscode/obsidian-js-engine-plugin"],"tags_count":42,"template":false,"template_full_name":"obsidianmd/obsidian-sample-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mProjectsCode%2Fobsidian-js-engine-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mProjectsCode%2Fobsidian-js-engine-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mProjectsCode%2Fobsidian-js-engine-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mProjectsCode%2Fobsidian-js-engine-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mProjectsCode","download_url":"https://codeload.github.com/mProjectsCode/obsidian-js-engine-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247427006,"owners_count":20937201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T07:47:13.199Z","updated_at":"2025-04-06T03:06:33.779Z","avatar_url":"https://github.com/mProjectsCode.png","language":"TypeScript","funding_links":["https://github.com/sponsors/mProjectsCode"],"categories":[],"sub_categories":[],"readme":"# Obsidian JS Engine Plugin\n\nThis plugin for Obsidian allows you to run JavaScript from within your notes using special code blocks.\n\n## Usage\n\nStart by creating a code block with `js-engine` as the code block language.\nInside the code block you can write what ever JavaScript code that you want.\nThe plugin will run the JavaScript and render the returned value in place of the code block.\n\n````md\n## This is a Note in Obsidian\n\n```js-engine\nreturn engine.markdown.create('*test*');\n```\n````\n\n## API Docs\n\nDocs are available [here](https://www.moritzjung.dev/obsidian-js-engine-plugin-docs/).\n\n## Examples\n\n### Markdown Builder\n\n```js\nlet markdownBuilder = engine.markdown.createBuilder();\n\nmarkdownBuilder.createHeading(2, 'Test Heading');\nmarkdownBuilder.createParagraph('This is a test paragraph.');\n\nmarkdownBuilder.createHeading(3, 'This is a sub heading');\nmarkdownBuilder.createHeading(4, 'This is a sub sub heading');\nmarkdownBuilder.createParagraph('This is another test paragraph.');\n\nreturn markdownBuilder;\n```\n\n#### Output\n\n\u003e ## Test Heading\n\u003e\n\u003e This is a test paragraph.\n\u003e\n\u003e ### This is a sub heading\n\u003e\n\u003e #### This is a sub sub heading\n\u003e\n\u003e This is another test paragraph.\n\n### Rendering Strings as Markdown\n\n```js\nlet str = '*test*';\nreturn str;\n```\n\n```js\nlet str = '*test*';\nreturn engine.markdown.create(str);\n```\n\nThe top example renders the string as plain text and the second one renders the text as markdown.\n\n#### Output\n\n\u003e \\*test\\*\n\n\u003e _test_\n\n### Importing JS\n\n```js\nlet lib = await engine.importJs('lib.js');\nreturn lib.getGreeting();\n```\n\nWith a file named `lib.js` in the root of the vault.\n\n```js\nexport function getGreeting() {\n\treturn 'Hello!';\n}\n```\n\n#### Output\n\n\u003e Hello!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmprojectscode%2Fobsidian-js-engine-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmprojectscode%2Fobsidian-js-engine-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmprojectscode%2Fobsidian-js-engine-plugin/lists"}