https://github.com/karimaziev/flymake-org

Run org-lint with flymake.
https://github.com/karimaziev/flymake-org

Last synced: 4 days ago
JSON representation

Run org-lint with flymake.

• Host: GitHub
• URL: https://github.com/karimaziev/flymake-org
• Owner: KarimAziev
• License: gpl-3.0
• Created: 2023-12-01T13:58:46.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-11-09T13:02:31.000Z (5 days ago)
• Last Synced: 2024-11-09T13:24:24.366Z (5 days ago)
• Language: Emacs Lisp
• Size: 35.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
#+OPTIONS: ^:nil tags:nil num:nil

* About

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

* Table of Contents                                       :TOC_2_gh:QUOTE:

#+BEGIN_QUOTE

- [[#about][About]]

- [[#requirements][Requirements]]

- [[#installation][Installation]]

  - [[#with-use-package-and-straightel][With use-package and straight.el]]

  - [[#manual-installation][Manual installation]]

- [[#usage][Usage]]

  - [[#minor-mode][Minor mode]]

  - [[#commands][Commands]]

#+END_QUOTE

* Requirements

| Name  | Version |

|-------+---------|

| Emacs |    29.1 |

| ~org~ |  9.6.11 |

* Installation

** With use-package and straight.el

#+begin_src elisp :eval no

(use-package flymake-org

  :straight (flymake-org

             :repo "KarimAziev/flymake-org"

             :type git

             :host github)

  :commands (flymake-org-mode))

#+end_src

** Manual installation

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

#+begin_src shell :eval no

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

#+end_src

Add the downloaded directory to the load path:

#+begin_src elisp :eval no

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

(require 'flymake-org)

#+end_src

* 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.