Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 1.43 KB

Contributing to Obsidian Enhancing Export

First, thank you for your willingness to contribute to this project.

Simple guide

  1. Environment Preparing

    • Install the nodejs

      https://nodejs.org/en/download

    • Install the pnpm

      npm install -g pnpm
    • Clone the repository

      git clone https://github.com/mokeyish/obsidian-enhancing-export.git
      
    • Install the dependencies

      cd obsidian-enhancing-export
      pnpm install
  2. Development & debugging (Recommend VsCode)

    • Add .env.local to project root with following content

      # export to obsidian plugin directory directly
      OUT_DIR="path/to/.obsidian/plugins/obsidian-enhancing-export"
    • Enable dev-mode

      To enable dev-mode in the obsidian, use the shortcut Ctrl+Shift+I or the <F12> key to open DevTools. and run following commands in the Console Tab of DevTools.

      localStorage.setItem('debug-plugin', '1')
    • Build the code for debugging

      npm run dev

      More debug tips please see: How to debug TypeScript in Chrome

  3. Building for Production

    npm run build
  4. Other commands please see sciprts of package.json in the project root.