commit 8088053341f23c0e9fd541a6cd0433b8f7ec2e6a Spenser Truex <web@spensertruex.com> 2019-12-07 18:19:30 -0800 Minor edits, grammar, keybinding suggestion.
coleslaw-mode.post | 54 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 26 deletions(-)
diff --git a/coleslaw-mode.post b/coleslaw-mode.post index cf8ae15..a28a494 100644 --- a/coleslaw-mode.post +++ b/coleslaw-mode.post @@ -17,7 +17,7 @@ tags: release (:p (esc "When opening a new .page or .post file, coleslaw mode will help you insert the metadata headers for the post. It will also help you choose the right mode, based on the format style for the page. All this is done automatically -when a file is opened")) +when a file is opened.")) (:p (esc "Example metadata header:") :br (:pre @@ -31,21 +31,38 @@ when a file is opened")) :br ";;;;;")) (:p "This prevents errors when writing the header, and the mode dispatch -prevents typing \"M-x markdown-mode\" or a similar mode-setting commands when -opening a file for Coleslaw.") +prevents needing to type <code>M-x markdown-mode</code> or a similar +mode-setting commands when opening a file for Coleslaw.") (:h4 (esc "How do I install it?")) -(:p (esc "Either from source (via ") - (:a :href "https://framagit.org/steckerhalter/quelpa" "Quelpa") - (esc ") or from Melpa, once coleslaw-mode is accepted in this version of - Melpa. Putting this in your init file:") - :br - (:pre "(setq auto-insert t)") - :br - (esc "Interactively inserts the header when opening new coleslaw files.")) +(:ol (:li (esc "Either from source (via ") + (:a :href "https://framagit.org/steckerhalter/quelpa" "Quelpa") + (esc ") or from Melpa, once coleslaw-mode is accepted in this version of + Melpa.")) + (:li (esc "Then either enable auto-insert, or bind the header generating + function to a key:") + :br + (:pre "(auto-insert t)" + :br + "(define-key coleslaw-mode (kbd \"M-`\") 'coleslaw-insert-header)") + )) (:p (esc "Subscribe to the mailing list ") (:strong (:a :href "https://mailman.common-lisp.net/listinfo/coleslaw" (esc "coleslaw@common-lisp.net"))) ".") + +(:h4 (:a :class "jump" :name "todo" "TODO")) + +(:ul (:li "Bind emacs commands for interacting with coleslaw via " + (:a :href "https://common-lisp.net/project/slime/" "slime") + " and sly." + " For example: to push up the code, or to commit it.") + (:li "Add org-mode to coleslaw and coleslaw-mode") + (:li (esc "Offer a way to grovel the user's coleslawrc for tags and other information.")) + (:li (esc "Autogenerated docs")) + (:li (esc "Get on Melpa.")) + (:li (esc "Fix/categorize/report bugs (github issues).")) + (:li (esc "Add non-intrusive features."))) + (:h5 "Edit documentation") (:div :class "press" (:div :class "logo" (:img :src @@ -66,18 +83,3 @@ opening a file for Coleslaw.") (:a :href "https://github.com/kingcons/coleslaw" "Contribute to coleslaw, the Common Lisp static content generator.")) - -(:h4 (:a :class "jump" :name "todo" "TODO")) - -(:ul (:li "Bind emacs commands for interacting with coleslaw via " - (:a :href "https://common-lisp.net/project/slime/" "slime") - " and sly." - " For example: to push up the code, or to commit it.") - (:li "Add org-mode to coleslaw and coleslaw-mode") - (:li (esc "Customizable variables via Emac's customization utility")) - (:li (esc "Realtime coleslaw generation, like with markdown-live-preview -modes.")) - (:li (esc "Offer a way to grovel the user's coleslawrc for tags and other information.")) - (:li (esc "Autogenerated docs")) - (:li (esc "Get on Melpa.")) - (:li (esc "Fix/categorize/report bugs (github issues).")))