Giter VIP home page Giter VIP logo

np-obsidian-index-wikilinks's Introduction

Turn an Obsidian vault into a JSON index with backlinks

This script reads in a folder of Markdown files, notes all the [[wiki-style links]] between them, then create an index (JSON format) with their indexes and backlinks ("referenced_by" field).

Usage

Installation

To install from this repo, run:

yarn global add https://github.com/ValentinViennot/np-obsidian-index-wikilinks.git
npm install -g https://github.com/ValentinViennot/np-obsidian-index-wikilinks.git

Execution

index-wikilinks path/to/folder/containing/md/files index.json

That will run it once; you'll need to create a cron job or a launch daemon to run it regularly.

If you store your notes in a Git repository and would like to run it on every push, see this Github Actions Workflow from Rajesh Shashi Kumar.

Building a local copy

You can use the provided .devcontainer config in VSCode.

npm install
npm run build

Thanks

Inspired by the work of Andy Matuschak

np-obsidian-index-wikilinks's People

Contributors

valentinviennot avatar

Stargazers

Miguel Pimentel avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.