A Vale client for Obsidian.

Overview

Obsidian Vale

Build Obsidian plugin Buy me a coffee

A Vale client for Obsidian.

Screenshot

Prerequisites

Configuration

To install Vale CLI:

  1. Go to their release page.
  2. Under Assets, download the version for your operating system.
  3. Extract the downloaded archive.

To configure the plugin:

  1. Go to the settings tab for the plugin.
  2. Enable Use CLI.
  3. In CLI: Path, enter the absolute path to the vale (vale.exe on Windows).

To get the most out of Vale, you want to install some styles. By default, only one style is enabled for basic spellchecking.

To add more styles, you need to install and enable them:

  1. In the Command Palette, select Vale: Install style.
  2. Select the style you want to install.
  3. In the Command Palette, select Vale: Enable style.
  4. Select the style you want to enable.

Advanced users

The plugin ships with a basic .vale.ini configuration file, which you can find at .obsidian/plugins/obsidian-vale/data/.vale.ini.

If you're using your own configuration file, you can still use the plugin to manage your styles.

Comments
  • Plugin isn't turn on in obsidian

    Plugin isn't turn on in obsidian

    app.js:1 Plugin failure: obsidian-vale Error: Cannot find module 'fs/promises'
    Require stack:
    - electron/js2c/renderer_init
        at Module._resolveFilename (internal/modules/cjs/loader.js:972)
        at Function.i._resolveFilename (electron/js2c/renderer_init.js:35)
        at Module._load (internal/modules/cjs/loader.js:848)
        at Function.f._load (electron/js2c/asar_bundle.js:5)
        at Module.require (internal/modules/cjs/loader.js:1032)
        at require (internal/modules/cjs/helpers.js:72)
        at Le (app.js:1)
        at a (app.js:1)
        at anonymous (eval at <anonymous> (app.js:1), <anonymous>:367:35289)
        at t.<anonymous> (app.js:1)
    
    opened by iGusev 5
  • Feature Request: Toggle the Editorial Marks' Visibility

    Feature Request: Toggle the Editorial Marks' Visibility

    I'm so excited to have this plugin. Thank you for making it.

    I have a request for a feature that could be helpful. It seems that once I've checked an Obsidian document with vale, there's no way to hide the marks it makes for errors and suggestions. Could there be a way to toggle these? Sometimes I shift between editing and writing modes and it's helpful to remove distractions during the writing mode. Could there be a feature to toggle the marks off and on?

    enhancement 
    opened by dylan-k 4
  • Question: method to check grammar

    Question: method to check grammar

    Hi - thank you for creating this tool. I am hoping you can point me to a way to have grammar checked - for instance the following sentence: "This is sentence that suck." This is not flagged with any of the linters that I am able to install (Google, Microsoft, prolint).

    Thank you for your help, I realize this is not an issue at all with your plugin - it works beautifully.

    opened by ms3056 4
  • Feature Request: Integrate Obsidian dictionary into default style

    Feature Request: Integrate Obsidian dictionary into default style

    Thank you for making this plugin, it seems really useful!

    When trying it out, the suggestion list was polluted with a lot of special terms, that I already added to the obsidian dictionary. After manually copying them into the default style, the plugin became usable for me.

    I think this plugin could really benefit from an option that did this automatically. (Apologies if this is already planned)

    enhancement 
    opened by fruchtblase 3
  • Manually add styles?

    Manually add styles?

    I just discovered Openly, the Vale linter style.

    I know that Openly is mentioned in this obsidian-vale conversation, but until Openly is possibly added to obsidian-vale, it sparked a question:

    Is it possible to manually add styles to obsidian-vale?

    I downloaded and copied the Openly folder (that contains Vale-formatted .yml files) to the .obsidian/plugins/obsidian-vale/data/styles folder, restarted Obsidian, tried to check plugin settings, even tried to run the plugin again, but it seems not to trigger anything.

    I'm definitely not a developer and don't have the skills required to troubleshoot this; it could very well be that the Openly files aren't compatible with obsidian-vale, but still...

    opened by pivic 2
  • Vale doesn't run if Vale view open on start up

    Vale doesn't run if Vale view open on start up

    I've noticed that if the Vale view is open when obsdian starts, then running Vale does nothing, I need to close the view first.

    Obsidian: 0.12.17 Mac OSX: 11.6 Vale 0.8.2

    opened by channingwalton 2
  • Getting started docs in text?

    Getting started docs in text?

    Hello! I was curious about trying out vale, but I am deaf and when i clicked into the video on Vimeo I didn't see captions. Are these available somewhere, or is the text of the video available?

    opened by brimwats1 1
  • Vale check produces no results

    Vale check produces no results

    Running Obsidian v0.15.2, the latest version of Vale.

    Problem description

    1. I select a file to fix.
    2. I run the command Vale: Check document.

    Expected result: the usual pane that produces vale results.

    Actual results: an empty Vale window:

    image

    Resolution attempts

    I've updated all of my Obsidian plugins and am running the latest version of Obsidian.

    I've restarted Obsidian.

    I've disabled and then enabled Vale.

    opened by npivic 8
  • Enable 'Readability': 'Error: child exited with code 2'

    Enable 'Readability': 'Error: child exited with code 2'

    Using Obsidian v0.13.21 with the latest obsidian-vale plugin, I've found that the following generates a problem:

    1. Go to Obsidian > Settings > Vale.
    2. Enable Readability.
    3. Check a file with Vale.

    The error says the following:

    'Something went wrong ... Error: child exited with code 2'

    When I disable Readability and check a file with Vale, the error does not recur.

    When Readability is enabled, everything in its options section is enabled and set to default.

    opened by pivic 2
  • Commands are missing in reader mode

    Commands are missing in reader mode

    I just discovered this plugin and it seems amazing. Thanks for your incredible work, it's absolutely impressive. Now, why would anyone use Grammarly, when we have this! 😄


    I wanted to check if I did any mistakes. It surprised me that the vale commands were missing from command pallete. I thought that the plugin broke, so I tried configuring it, installing a non-managed version of CLI, and yet it still didn't work. Then, I realized that this plugin only allows to check document when user is in source mode - which might be unintuitive for... some users! 😅

    TL;DR: please consider allowing user to check while in reader mode.

    opened by konhi 0
  • An option to not lint files in some languages

    An option to not lint files in some languages

    I write in English and Norwegian, and while Vale works great in English, the Norwegian language isn't supported. This is as expected, given the tiny size of the Norwegian-speaking population in the world - but I lint-on-save on, and then I get tons of errors because none of my words are "correct".

    Could this be solved by checking for a language attribute in frontmatter, or even by simply testing to see if more than XX% of all words are marked as error making an assumption that Vale is not actually required?

    I assume the first is easiest - just a simple (dis-)allowlist of languages in the settings, and checking a frontmatter tag.

    opened by tofagerl 0
  • TypeError: r.getAllMarks

    TypeError: r.getAllMarks

    Obisidian version v0.13.0

    Uncaught TypeError: r.getAllMarks is not a function
        at eval (eval at <anonymous> (app.js:1), <anonymous>:367:59524)
        at Y8.withCodeMirrorEditor (eval at <anonymous> (app.js:1), <anonymous>:367:60241)
    
    bug 
    opened by channingwalton 16
Releases(0.9.0)
Owner
Marcus Olsson
Marcus Olsson
Add linked data to the YAML of your Obsidian notes.

Obsidian Linked Data Vocabularies Plugin This plugin adds YAML keys for the selected heading, url (optional), and broader, narrower and related headin

null 53 Oct 13, 2022
Termbase für Übersetung in Form eines Obsidian Vault

lang file-id authors date tags topics en 2ff3822a-cc5f-4474-ab4e-d097dcc3a215 [email protected] 2022-01-06 #needs_completion #readme #winos #setup Readme

null 2 Jan 8, 2022
The HTTP client for Vue.js

vue-resource The plugin for Vue.js provides services for making web requests and handle responses using a XMLHttpRequest or JSONP. Features Supports t

Pagekit 10.1k Dec 30, 2022
🏎 A tiny and fast GraphQL client for Vue.js

villus Villus is a finger-like structures in the small intestine. They help to absorb digested food. A small and fast GraphQL client for Vue.js. This

Abdelrahman Awad 639 Jan 8, 2023
Prefetch and sync state to client with one line of code, out-of-the-box

vue3-SSR-starter Prefetch and sync state to client with one line of code, out-of-the-box Features vue3 SSR vue-router we don't need vuex anymore one l

周子贤 36 Aug 28, 2022
⚡️ Minimal GraphQL Client + Code Generation for Nuxt

nuxt-graphql-client ⚡️ Minimal GraphQL Client + Code Generation for Nuxt ⚡️ Minimal GraphQL Client + Code Generation for Nuxt Features Zero Configurat

Dizzy 245 Dec 27, 2022
⚡️ Minimal GraphQL Client + Code Generation for Nuxt3

nuxt-graphql-client ⚡️ Minimal GraphQL Client + Code Generation for Nuxt ⚡️ Minimal GraphQL Client + Code Generation for Nuxt Documentation Features Z

Conrawl Rogers 245 Dec 27, 2022
A client for QQ and more.:electron:

Icalingua++ Icalingua++ 是 Icalingua 的分支,為已經刪除的 Icalingua 提供有限的更新,同時歡迎社區提交PR。 Icalingua 这个名字是日语中「光」和拉丁语中「语言」的组合。 本项目希望为 Linux 打造一个会话前端框架,通过实现 Adapter 后

Icalingua++ 2.6k Dec 31, 2022
Restream is a module that allows you to create a stream of an audio/video file from the Firebase storage, protected from direct download through the client-side.

nuxt-restream Restream is a module that allows you to create a stream of an audio/video file from the Firebase storage, protected from direct download

Restorm 3 Dec 13, 2022
Nuxt eureka client

Nuxt eureka client

Kirill 5 May 30, 2022
Remove all client-side JS from your Nuxt 3 app

Nuxt Zero JS Remove all client-side JS from your Nuxt 3 app ✨ Changelog ▶️ Online playground Features ⚠️ nuxt-zero-js is under active development. ⚠️

Daniel Roe 163 Jan 3, 2023
Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

JavaScript-med-Ramverk-Laboration-3 Grupprojektet för kurserna Javascript med Ramverk och Agil Utveckling. Utvecklingsguide För information om hur utv

Svante Jonsson IT-Högskolan 3 May 18, 2022
Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

null 4 May 3, 2022
Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

null 14 Jan 3, 2023
A plugin for Obsidian (https://obsidian.md) that adds a button to its search view for copying the Obsidian search URL.

Copy Search URL This plugin adds a button to Obsidian's search view. Clicking it will copy the Obsidian URL for the current search to the clipboard. T

Carlo Zottmann 6 Dec 26, 2022
An Obsidian plugin to paste Excel tables as Markdown tables in Obsidian editor.

Obsidian Excel to Markdown Table An Obsidian plugin to paste Excel tables as Markdown tables in Obsidian editor. Demo You can paste the copied Excel d

Ganessh Kumar 108 Jan 4, 2023
Obsidian To HTML, A template for building obsidian style notes to a static site

oth (Obsidian To HTML) This is a template for publishing obsidian notes as a static site. The goal of the project is to stay minimal, since this is a

Ulisse mini 11 Nov 4, 2022
Obsidian-dataview-table-filter-menu - Dynamically created filter menu for dataview tables in obsidian

Dataview table Filter Menu for Obsidian Dynamically created filter menu for data

shiro 17 Sep 24, 2022
Obsidian-Snippet-collection - A collection of snippet to customize obsidian

This repo is a collection of CSS snippets for Obsidian.md. To install them on PC

Mara 110 Dec 22, 2022
Obsidian Web: Connect your browser with your Obsidian notes

Obsidian Web: Connect your browser with your Obsidian notes This is an unofficial Chrome extension for Obsidian that lets you send content from the we

Adam Coddington 97 Jan 3, 2023