From 89068d88d4eca3ebefdd322064969586d01caadf Mon Sep 17 00:00:00 2001 From: Jeetaditya Chatterjee Date: Sat, 22 Aug 2020 18:32:02 +0100 Subject: [PATCH] adding the requested changes --- modules/ui/hl-todo/README.org | 62 ++++++++++++++++++--------------- modules/ui/ligatures/README.org | 30 ++++++++-------- 2 files changed, 47 insertions(+), 45 deletions(-) diff --git a/modules/ui/hl-todo/README.org b/modules/ui/hl-todo/README.org index 15e62368a..1898ce03d 100644 --- a/modules/ui/hl-todo/README.org +++ b/modules/ui/hl-todo/README.org @@ -1,4 +1,7 @@ #+TITLE: :ui hl-todo +#+DATE: February 19, 2017 +#+SINCE: v1.3 +#+STARTUP: inlineimages * Table of Contents :TOC_3:noexport: - [[#description][Description]] @@ -7,7 +10,8 @@ - [[#prerequisites][Prerequisites]] - [[#features][Features]] - [[#making-items][Making Items]] - - [[#using-items][Using Items]] + - [[#keybindings][Keybindings]] + - [[#adding-items][Adding items.]] - [[#configuration][Configuration]] - [[#troubleshooting][Troubleshooting]] @@ -17,11 +21,15 @@ major-modes. ** Module Flags This module provides no flags + ** Plugins -[[https://github.com/tarius/hl-todo][hl-todo]] ++ [[https://github.com/tarius/hl-todo][hl-todo]] + * Prerequisites This module has no prerequisites + * Features + ** Making Items You can make a TODO item by simply writing + =TODO= @@ -43,37 +51,33 @@ You can make a TODO item by simply writing For a known bug that needs a workaround + =XXX= For warning about a problematic or misguiding code -** Using Items -To see all of the TODO items in a project you can use -=SPC p t= -This will bring up a buffer you can use to quickly jump to the item + +** Keybindings +| keybind | description | +|-----------+----------------------------------| +| =]t= | go to next TODO item | +| =[t= | go to previous TODO item | +| =SPC p t= | show all TODO items in a project | +| =SPC s p= | search project for a string | +| =SPC s b= | search buffer for string | + +** TODO Adding items. +The way you would add a TODO item is to use a snippet but these have not been +made. you can make them yourself by adding the snippet to +=$DOOMDIR/snippets/MAJOR-MODE/name-of-snippet=. you will find more info on how +to make them [[https://github.com/hlissner/doom-snippets][here]] + * Configuration To add your own ITEMS you would need to configure them using ~hl-todo-keyword-faces~ -#+BEGIN_SRC emacs-lisp :tangle no +#+BEGIN_SRC emacs-lisp ;; the default -(setq hl-todo-keyword-faces - `(("FOO" . ,(face-foreground "MY COLOUR HEX CODE")) - ("BAR" . ,(face-foreground 'my-colour-var)))) +(after! hl-todo + (setq hl-todo-keyword-faces + `( + ("FOO" . ,(face-foreground "MY COLOUR HEX CODE")) + ("BAR" . ,(face-foreground 'my-colour-var))))) #+END_SRC -You can also add keybindings to jump and configure the next TODO item in the buffer using -| function | description | proposed binding | -|--------------------+-----------------------------------+------------------| -| ~hl-todo-previous~ | move to the last TODO item | =C-c t p= | -| ~hl-todo-next~ | move to the next TODO item | =C-c t n= | -| ~hl-todo-occur~ | list all TODO items in the buffer | =C-c t o= | -| ~hl-todo-insert~ | make a new TODO item | =C-c t i= | - -this can be mapped like this -#+BEGIN_SRC emacs-lisp :tangle no -(map! :prefix "C-c t" - "p"#'hl-todo-previous - "n"#'hl-todo-next - "o"#'hl-todo-occur - "i"#'hl-todo-insert) - -#+END_SRC - -* Troubleshooting +* TODO Troubleshooting If you have any problems with this module do get in touch! diff --git a/modules/ui/ligatures/README.org b/modules/ui/ligatures/README.org index 4179ed54a..df5a16271 100644 --- a/modules/ui/ligatures/README.org +++ b/modules/ui/ligatures/README.org @@ -16,8 +16,8 @@ - [[#mathematical-symbols-replacement][Mathematical symbols replacement]] - [[#coding-ligatures][Coding ligatures]] - [[#configuration][Configuration]] - - [[#setting-liagtures][Setting liagtures]] - - [[#changing-ligatures][changing ligatures]] + - [[#setting-ligatures][Setting ligatures]] + - [[#changing-ligatures][Changing ligatures]] - [[#troubleshooting][Troubleshooting]] * Description @@ -102,18 +102,18 @@ Even though harfbuzz has been included in emacs 27, there is currently a [[https (#40864)]] which prevents a safe usage of /composition-function-table/ method in emacs 27. -* TODO Configuration -** Setting liagtures +* Configuration +** Setting ligatures If you want to set ligatures for modules that don't have them by default you can -use the ~set-ligatures!~ macro in your config.el file +use the ~set-ligatures!~ macro in your config el file #+BEGIN_SRC emacs-lisp -(after! major-mode - (set-ligatures! 'major-mode +(after! PACKAGE + (set-ligatures! 'MAJOR-MODE :symbol "keyword")) #+END_SRC eg. #+BEGIN_SRC emacs-lisp -(after! go-mode +(after! go-mode ; in this case the major mode and package named the same thing (set-ligatures! 'go-mode :def "func" ; function keyword :true "true" :false "false" @@ -126,7 +126,7 @@ eg. #+END_SRC you can set these symbols out of the box #+BEGIN_SRC emacs-lisp -(set-ligatures! 'mode +(set-ligatures! 'MAJOR-MODE ;; Functional :lambda "lambda keyword" :def "function keyword" @@ -160,21 +160,19 @@ you can set these symbols out of the box :dot "Dot operator") #+END_SRC - -if you have multiple versions of the same keyword you can set the symbol twice +If you have multiple versions of the same keyword you can set the symbol twice #+BEGIN_SRC emacs-lisp (set-ligatures! scala-mode :null "none" :null "None") - #+END_SRC -** changing ligatures +** Changing ligatures if you don't like the symbols chosen you can change them by using... #+BEGIN_SRC emacs-lisp -; you don't need to include all of them you can pick and mix -(setq +ligatures-extra-symbols +;; you don't need to include all of them you can pick and mix +(plist-put +ligatures-extra-symbols '(;; org :name "»" :src_block "»" @@ -216,4 +214,4 @@ if you don't like the symbols chosen you can change them by using... #+END_SRC * TODO Troubleshooting -# Common issues and their solution, or places to look for help. + If you have any problems with this module, do get in touch!