https://github.com/ejfox/nuxt-module-obsidian
https://github.com/ejfox/nuxt-module-obsidian
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ejfox/nuxt-module-obsidian
- Owner: ejfox
- Created: 2023-10-31T23:47:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-01T00:01:16.000Z (over 2 years ago)
- Last Synced: 2026-04-03T21:49:49.143Z (2 months ago)
- Language: TypeScript
- Size: 145 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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
## Footnotes, backlinks, and wikilinks
## Canvas Support
## Frontmatter / Properties
## Table of Contents
## Obsidian Plugin Support
### Kindle Highlights
## Quick Setup
1. Add `obsidian` dependency to your project
```bash
# Using pnpm
pnpm add -D obsidian
# Using yarn
yarn add --dev obsidian
# Using npm
npm install --save-dev obsidian
```
2. Add `obsidian` to the `modules` section of `nuxt.config.ts`
```js
export default defineNuxtConfig({
modules: [
'obsidian'
]
})
```
That's it! You can now use Obsidian in your Nuxt app ✨
# Development
```bash
# 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
```