Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

could you include an example of importing a function from a script in the README?

Open
#35 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Start with the README and review how js-engine currently loads scripts. Use the reported nifty-links.js path and its exported getFromOpenGraph(url) function as the example, including the expected rendered HTML result and the related CSS path. Done means a newcomer can follow the README to reproduce this setup.

Written by the indexing model from the issue text.

Description

Hi,

I'm trying to write modular JavaScript and have one file for each script. It's not working out for me ;)

I'll explain more, but pretty sure it would be helpful just to show how it would work in your readme.

Okay I have nifty-links.js
vault/js/scripts/nifty-links
that has an exported function called "getFromOpenGraph(url)"

I have a nifty-links.css
./obsidian/snippets/nifty-links.css

This all works using a basic liveserver in a browser.

I want to use js-engine to call that function and pass it a URL, and then what should come back is rendered HTML.

Dominant language
TypeScript
Stars
191
Forks
15
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mProjectsCode/obsidian-js-engine-plugin

All issues in mProjectsCode/obsidian-js-engine-plugin

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.