commit dfbd4cb1bd3bf9fcfdd8c35bcc1b4596006db31b Spenser Truex <spensertruexonline@gmail.com> 2019-06-17 21:09:34 -0700 0.2.4 (melpa subimssion).
coleslaw-mode.post | 87 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 57 insertions(+), 30 deletions(-)
diff --git a/coleslaw-mode.post b/coleslaw-mode.post index 3f88fa9..9126385 100644 --- a/coleslaw-mode.post +++ b/coleslaw-mode.post @@ -5,34 +5,45 @@ date: 2019-06-09 excerpt: An Emacs mode for authoring Coleslaw posts and pages. image: /static/coleslaw.png url: coleslaw-mode +tags: release ;;;;; (:h2 (esc "An Emacs mode for authoring Coleslaw posts and pages.")) -(:h3 (esc "Beta: Version 0.x.x")) -(:h4 "Do What I Mean mode for editing coleslaw. There's not much to learn, just -use it.") +(:h3 (esc "Beta: Version 0.2.4")) +(:h4 "Mode for editing " + (:a :href "https://github.com/kingcons/coleslaw" "Coleslaw") + " files.") (:h4 (esc "What does it do?")) (: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 but you can call it with -coleslaw-insert-header-or-dispatch after changing the \"format: \" field.")) +mode, based on the format style for the page. All this is done automatically +when a file is opened") + " after changing the \"format: \" field.") (:p (esc "Example metadata header:") - (:pre (esc ";;;;; -title: Example -format: md -date: 1970-01-01 -;;;;;"))) -(:h4 "Keybindings") -(:ul (:li (esc "M-; → apply the mode based on the header, or insert a header in -this file if there isn't.")) - (:li (esc "That's it."))) + :br + (:code ";;;;;" + :br + "title: Example" + :br + "format: md (coleslaw-mode prevents wrong format values)" + :br + "date: 1970-01-01 (automatically the current date)" + :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.") (:h4 (esc "How do I install it?")) (:p (esc "Either from source (via ") - (:a :href "Quelpa" "https://framagit.org/steckerhalter/quelpa") - (esc ") or from Melpa, if coleslaw-mode is accepted in this version of - Melpa. Some .emacs configuration is necessary.") - (:pre (esc "(coleslaw-setup)")) - (esc "is enough to get you setup with the standard mode decisions of the author.")) + (: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 + (:code (esc "(coleslaw-setup)")) + :br + (esc "is enough to get you setup with the standard mode decisions of the + author. You might need to install the dependencies. See them in the ") + (:code "coleslaw-modes") + " variable.") (:h5 "Optional Dependencies") (:ul (:li (esc "For markdown syntax highlighting, ") (:a :href "https://jblevins.org/projects/markdown-mode/" @@ -49,7 +60,7 @@ this file if there isn't.")) (:code (esc "(coleslaw-setup)")) (esc " then consider modifying")) -(:code (esc "coleslaw-default-format-modes")) +(:code (esc "coleslaw-formats")) (:p (esc "for choosing which modes to dispatch based on the header.")) (:code (esc "(add-to-list 'auto-insert-alist '(\".coleslaw\" . coleslaw-insert-header))")):br @@ -65,15 +76,26 @@ since they are not conservative enough choices:") help you edit.") (:li "Lisp has a number of editing modes (useful with cl-who) which overlap to a great extent and are highly personal. Add them as hooks to - lisp-mode, or write your own coleslaw-default-format-modes."))) + lisp-mode, or write your own " (:code "coleslaw-default-format-modes") "."))) + +(:h4 "Troubleshooting") +(:h5 "Wrong separator") +(:p (esc "If your file contains any ") + (:code "\";;;;;\"") + (esc " that isn't the header separator, +coleslaw-mode will break. You can change the separator in the .coleslawrc for +Coleslaw, and in coleslaw-mode with ") + (:code "(setq coleslaw-separator \"-----\")") + (esc " or a different choice of separator in your init file.")) (:h4 "How can I contribute or get help?") -(:p (esc "Coleslaw-mode is still an early project. It doesn't have (but would be + (:p (esc "Coleslaw-mode is still an early project. It doesn't have (but would be nice to have) customizable variables, realtime integration with slime or sly, realtime integration with colesleaw, better and/or autogenerated docs, be added -to popular code repos, and is generally unfinished. The " - (:a :href "#todo" "TODO") (esc "is a good place to start."))) +to popular code repos, and is generally unfinished and buggy. The ") + (:a :href "#todo" "TODO") + (esc " is a good place to start.")) (:p "Coleslaw has a channel on freenode: " (:strong (esc "#coleslaw"))) (:p "Coleslaw might get a mailing list at some point, and if it did, you could @@ -104,11 +126,16 @@ square (tombstone/halmos), □."))) "Contribute to coleslaw, the Common Lisp static content generator.")) -(:h4 (:a :class "title" "#todo" "TODO")) +(: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") - ". For example: to push up the code, or to commit it.") - (:li "Detect format line to enable correct mode in a non-new file.") - (:li "Allow for alternative preview mode") - (:li "Add org-mode to coleslaw and coleslaw-mode")) + " 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 "Autogenerated docs")) + (:li (esc "Get on Melpa.")) + (:li (esc "Fix/categorize/report bugs (github issues).")))