Coder Social home page Coder Social logo

obsidian-quartz-publish's Introduction

Obsidian Quartz Publish

Overview

obsidian-quartz-publish is a command-line tool designed for seamless integration between Obsidian, a powerful note-taking and knowledge management application, and Quartz, a static site generator. This tool simplifies the process of publishing selected Obsidian notes to Quartz by automating the transfer of relevant content and embedded files.

Features

  • Effortless Publication: Identify notes for publishing in Obsidian by tagging them with #publish. obsidian-quartz-publish will recognize these tagged notes and transfer them to Quartz for further processing.

  • Smart Synchronization: The tool intelligently checks for changes within the specified Obsidian vault. If no modifications are detected in the notes marked for publishing, obsidian-quartz-publish refrains from copying files, optimizing the publishing process.

  • Embedded File Support: Ensure a comprehensive transfer by including all embedded files associated with the selected notes. obsidian-quartz-publish captures not only the note content but also any linked files, images, or attachments.

  • Seamless Quartz Integration: Once the transfer is initiated, obsidian-quartz-publish seamlessly integrates with Quartz, enabling it to build the updated site with the new content.

Prerequisites

  • Obsidian: Ensure that you have Obsidian installed and configured with your local vault.

  • Quartz: Set up Quartz as your static site generator, including the necessary configuration for content directories.

Installation

Simply get the newest executable or build it yourself.

Usage

  1. Tag the notes you want to publish in Obsidian with #publish.

  2. Run the following command to initiate the publishing process:

    obsidian-quartz-publish /absolute/path/to/vault /absolute/path/to/quartz_dir
  3. obsidian-quartz-publish will analyze the specified Obsidian vault, identify notes marked for publishing, and transfer them to the content directory of Quartz.

  4. If changes are detected, Quartz will build the updated site with the new content.

obsidian-quartz-publish's People

Contributors

a-wels avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

nrkimv6

obsidian-quartz-publish's Issues

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.