This repository has been archived on 2023-10-02. You can view files and clone it, but cannot push or open issues or pull requests.
svg-obsidian/README.md
2023-10-02 00:06:46 +02:00

3.8 KiB

SVG-Obsidian

NE FONCTIONNE PAS - Je comprends rien au délire de codemirror / faut définir une infinité de trucs pour faire un truc simple.

Plugin Obsidian pour pouvoir voir les SVG sans se soucier du thème clair/sombre.

Utile principalement pour les exports des dessins excalidraw.

How to use

  • Clone this repo.
  • Make sure your NodeJS is at least v16 (node --version).
  • npm i or yarn to install dependencies.
  • npm run dev to start compilation in watch mode.

Manually installing the plugin

  • Copy over main.js, styles.css, manifest.json to your vault VaultFolder/.obsidian/plugins/svg-obsidian/.

Improve code quality with eslint (optional)

  • ESLint is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
  • To use eslint with this project, make sure to install eslint from terminal:
    • npm install -g eslint
  • To use eslint to analyze this project use this command:
    • eslint main.ts
    • eslint will then create a report with suggestions for code improvement by file and line number.
  • If your source code is in a folder, such as src, you can use eslint with this command to analyze all files in that folder:
    • eslint .\src\

API Documentation

See https://github.com/obsidianmd/obsidian-api