KarimAziev / flymake-org

Run org-lint with flymake.

About

Perform on-the-fly linting in Org mode with Flymake.

Table of Contents

• About
• Requirements
• Installation
  • With use-package and straight.el
  • Manual installation
• Usage
  • Minor mode
  • Commands

Requirements

Name	Version
Emacs	29.1
org	9.6.11

Installation

With use-package and straight.el

(use-package flymake-org
  :straight (flymake-org
             :repo "KarimAziev/flymake-org"
             :type git
             :host github)
  :commands (flymake-org-mode))

Manual installation

Download the source code and put it wherever you like, e.g. into ~/.emacs.d/flymake-org/

git clone https://github.com/KarimAziev/flymake-org.git ~/.emacs.d/flymake-org/

Add the downloaded directory to the load path:

(add-to-list 'load-path "~/.emacs.d/flymake-org/")
(require 'flymake-org)

Usage

Minor mode

Run in org-mode:

M-x flymake-org-mode

Enable or disable Flymake for Org mode files to perform on-the-fly linting.

Commands

flymake-org-off

Disable Flymake for Org linting and start it.

flymake-org-on

Enable Flymake for Org linting and start it.