commit 13a6e6e074d1f0090e4304630e6b16f8230e1268 Spenser Truex <web@spensertruex.com> 2019-12-07 18:03:01 -0800 Update to 0.3.0.
coleslaw-mode.post | 111 +++++++++++++---------------------------------------- 1 file changed, 26 insertions(+), 85 deletions(-)
diff --git a/coleslaw-mode.post b/coleslaw-mode.post index d2c39c2..cf8ae15 100644 --- a/coleslaw-mode.post +++ b/coleslaw-mode.post @@ -1,35 +1,35 @@ ;;;;; -title: Coleslaw-mode +title: Coleslaw format: cl-who -date: 2019-06-09 +date: 2019-11-17 excerpt: An Emacs mode for authoring Coleslaw posts and pages. image: /static/coleslaw.png -url: coleslaw-mode +url: coleslaw tags: release ;;;;; (:h2 (esc "An Emacs mode for authoring Coleslaw posts and pages.")) -(:h3 (esc "Beta: Version 0.2.4")) +(:h3 (esc "Beta: Version 0.3.0")) (: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") - " after changing the \"format: \" field.") +mode, based on the format style for the page. All this is done automatically +when a file is opened")) (:p (esc "Example metadata header:") - :br - (:code ";;;;;" + :br + (:pre + ";;;;;" :br - "title: Example" + "title: Example" :br - "format: md (coleslaw-mode prevents wrong format values)" + "format: md" :br - "date: 1970-01-01 (automatically the current date)" + "date: 1970-01-01" :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.") @@ -39,69 +39,13 @@ opening a file for Coleslaw.") (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)")) + (:pre "(setq auto-insert t)") :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/" - "markdown-mode") - ".") - (:li (esc "For a preview of the markdown, ") - (:a :href "https://github.com/niku/markdown-preview-eww" - "Markdown-preview-eww") - (esc " (via (M/Q)elpa).")) - (:li (esc "Note that the eww (Emacs Web Wowser) has special OS level - dependencies."))) -(:h4 (esc "How do I customize it?")) -(:p (esc "If you don't like ") - (:code (esc "(coleslaw-setup)")) - (esc " then consider modifying")) - -(: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 -(:code (esc "(add-to-list 'auto-mode-alist '(\"\\\\.coleslaw\\\\'\" -. coleslaw-mode))")) -(:p (esc "are helpful templates for adding file types (in this case replace -.coleslaw with the file type of choice).")) - -(:p (esc "There are some configuration choices not built into the default setup, -since they are not conservative enough choices:") - :br - (:ul (:li "Markdown live preview for md, generates a web browser buffer to - 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 " (: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 -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 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 -subscribe.") - + (esc "Interactively inserts the header when opening new coleslaw files.")) +(:p (esc "Subscribe to the mailing list ") + (:strong (:a :href "https://mailman.common-lisp.net/listinfo/coleslaw" + (esc "coleslaw@common-lisp.net"))) + ".") (:h5 "Edit documentation") (:div :class "press" (:div :class "logo" (:img :src @@ -116,16 +60,12 @@ subscribe.") (:a :href "https://github.com/equwal/coleslaw" "Source code for coleslaw-mode")) -(:div :class "press" - (:div :class "logo" - (:img :src "/static/coleslaw.png" - :alt (esc "Coleslaw static content generator -logo. Plays with ;TODO: he word coleslaw a bit, replacing the O with parentheses, the -L with a λ, the e with a ∈, and ending with a quod erat demonstrandum marker -square (tombstone/halmos), □."))) - (:a :href "https://github.com/kingcons/coleslaw" - "Contribute to coleslaw, the Common Lisp static - content generator.")) +(:div :class "press" (:div :class "logo" (:img :src "/static/coleslaw.png" :alt + (esc "Coleslaw static content generator logo. Plays with the word coleslaw + a bit, replacing some characters with lisp-releated ones, like a lambda for an ell."))) + (:a :href + "https://github.com/kingcons/coleslaw" "Contribute to coleslaw, the Common + Lisp static content generator.")) (:h4 (:a :class "jump" :name "todo" "TODO")) @@ -137,6 +77,7 @@ square (tombstone/halmos), □."))) (: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).")))