Skip to main content
TypeScript

nuxt-module-obsidian

No description provided

Commits
3
Files
23
Size
603.5 KB
Langs
2
Stars
1
Created
Oct 31, 2023
Last push
almost 3 years ago
README.md

Nuxt Content: Obsidian

Bringing the magic of Obsidian to publishing with Nuxt Content. Contains a number of helpers and convenience composables to make it easier to pulish Markdown files from Obsidian without losing any functionality.

Interactive Graph

Canvas Support

Frontmatter / Properties

Table of Contents

Obsidian Plugin Support

Kindle Highlights

Quick Setup

  1. Add obsidian dependency to your project
# Using pnpm
pnpm add -D obsidian

# Using yarn
yarn add --dev obsidian

# Using npm
npm install --save-dev obsidian
  1. Add obsidian to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    'obsidian'
  ]
})

That's it! You can now use Obsidian in your Nuxt app ✨

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release