Recently Written · git

coleslaw-mode-docs

Documentation to coleslaw-mode for Emacs.

git clone https://github.com/equwal/coleslaw-mode-docs

Log | Files | Refs


coleslaw-mode.post (3336 bytes)

1 ;;;;;
2 title: Coleslaw
3 format: cl-who
4 date: 2019-11-17
5 excerpt: An Emacs mode for authoring Coleslaw posts and pages.
6 image: /static/coleslaw.png
7 url: coleslaw
8 tags: release
9 ;;;;;
10 
11 (:h2 (esc "An Emacs mode for authoring Coleslaw posts and pages."))
12 (:h3 (esc "Beta: Version 0.3.0"))
13 (:h4 "Mode for editing "
14      (:a :href "https://github.com/kingcons/coleslaw" "Coleslaw")
15      " files.")
16 (:h4 (esc "What does it do?"))
17 (:p (esc "When opening a new .page or .post file, coleslaw mode will help you
18 insert the metadata headers for the post. It will also help you choose the right
19 mode, based on the format style for the page. All this is done automatically
20 when a file is opened."))
21 (:p (esc "Example metadata header:")
22     :br
23     (:pre
24      ";;;;;"
25      :br
26      "title: Example"
27      :br
28      "format: md"
29      :br
30      "date: 1970-01-01"
31      :br
32      ";;;;;"))
33 (:p "This prevents errors when writing the header, and the mode dispatch
34 prevents needing to type <code>M-x markdown-mode</code> or a similar
35 mode-setting commands when opening a file for Coleslaw.")
36 (:h4 (esc "How do I install it?"))
37 (:ol (:li (esc "Either from source (via ")
38           (:a :href "https://framagit.org/steckerhalter/quelpa" "Quelpa")
39           (esc ") or from Melpa, once coleslaw-mode is accepted in this version of
40     Melpa."))
41      (:li (esc "Then either enable auto-insert, or bind the header generating
42      function to a key:")
43       :br
44           (:pre "(auto-insert t)"
45            :br
46                 "(define-key coleslaw-mode (kbd \"M-`\") 'coleslaw-insert-header)")
47           ))
48 (:p (esc "Subscribe to the mailing list ")
49     (:strong (:a :href "https://mailman.common-lisp.net/listinfo/coleslaw"
50                  (esc "coleslaw@common-lisp.net")))
51     ".")
52 
53 (:h4 (:a :class "jump" :name "todo" "TODO"))
54 
55 (:ul (:li "Bind emacs commands for interacting with coleslaw via "
56           (:a :href "https://common-lisp.net/project/slime/" "slime")
57           " and sly."
58           " For example: to push up the code, or to commit it.")
59      (:li "Add org-mode to coleslaw and coleslaw-mode")
60      (:li (esc "Offer a way to grovel the user's coleslawrc for tags and other information."))
61      (:li (esc "Autogenerated docs"))
62      (:li (esc "Get on Melpa."))
63      (:li (esc "Fix/categorize/report bugs (github issues)."))
64      (:li (esc "Add non-intrusive features.")))
65 
66 (:h5 "Edit documentation")
67 
68 (:div :class "press" (:div :class "logo" (:img :src
69                                                "/static/github.png" :alt "Github's logo"))
70       (:a :href
71           "https://github.com/equwal/coleslaw-mode-docs"
72           "The coleslaw-mode docs are available for free collaboration on
73           github."))
74 
75 (:div :class "press" (:div :class "logo" (:img :src
76                                                     "/static/github.png" :alt "Github's logo"))
77       (:a :href
78           "https://github.com/equwal/coleslaw" "Source code for coleslaw-mode"))
79 
80 (:div :class "press" (:div :class "logo" (:img :src "/static/coleslaw.png" :alt
81       (esc "Coleslaw static content generator logo. Plays with the word coleslaw
82       a bit, replacing some characters with lisp-releated ones, like a lambda for an ell.")))
83       (:a :href
84       "https://github.com/kingcons/coleslaw" "Contribute to coleslaw, the Common
85       Lisp static content generator."))