https://github.com/okomestudio/flycheck-aspell-org.el

An Org plug-in for flycheck-aspell, the spell checking helper mode in Emacs using flycheck.
https://github.com/okomestudio/flycheck-aspell-org.el

aspell emacs emacs-package flycheck org-mode

Last synced: 4 days ago
JSON representation

An Org plug-in for flycheck-aspell, the spell checking helper mode in Emacs using flycheck.

• Host: GitHub
• URL: https://github.com/okomestudio/flycheck-aspell-org.el
• Owner: okomestudio
• License: gpl-3.0
• Created: 2024-09-01T04:26:42.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-09-07T19:31:09.000Z (26 days ago)
• Last Synced: 2024-09-25T23:47:32.993Z (8 days ago)
• Topics: aspell, emacs, emacs-package, flycheck, org-mode
• Language: Emacs Lisp
• Homepage:
• Size: 27.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flycheck-aspell-org

An Org plug-in for flycheck-aspell, the spell checking helper mode in

Emacs using flycheck.

The plug-in filters the aspell output to skip spelling errors that

occur within some Org document structures. These include

- Text marked as inline code (enclosed by the "`~`" markup)

- Org tags and TODO labels

- Footnote structure (i.e., `[fn:`)

- Text constituting part of link specification (but not description, `[[link][desc]]`)

- Text used within per-file keyword, except title (e.g., `#+keyword: ...`)

- Text inside block structures (which begin with `#+begin_` and end with `#+end_`; src, html, latex, example)

## Installation

Follow the [instruction in the flycheck-aspell's

README](https://github.com/leotaku/flycheck-aspell/) for

flycheck-aspell installation.

Then add the following to your `init.el`:

``` emacs-lisp

(use-package flycheck-aspell-org

  :straight (:host github :repo "okomestudio/flycheck-aspell-org")

  :after (flycheck-aspell)

  :demand t)

```

## Usage

When installed, flycheck-aspell-org activates automatically in all the

Org mode.

## TODOs

- [ ] Add a switch to de/activate the plugin

- [ ] Make the module a minor mode