--- /dev/null
+Copyright 2021 Armaan Bhojwani <me@armaanb.net>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
\ No newline at end of file
--- /dev/null
+; This is the scdoc(5) manpage, used to test scdoc-mode.
+
+scdoc(5)
+
+
+# NAME
+
+scdoc - document format for writing manual pages
+
+# SYNTAX
+
+Input files must use the UTF-8 encoding.
+
+## PREAMBLE
+
+Each scdoc file must begin with the following preamble:
+
+ *name*(_section_) ["left\_footer" ["center\_header"]]
+
+*name* is the name of the man page you are writing, and _section_ is the section
+you're writing for (see *man*(1) for information on manual sections).
+
+_left\_footer_ and _center\_header_ are optional arguments which set the text
+positioned at those locations in the generated man page, and *must* be
+surrounded with double quotes.
+
+## SECTION HEADERS
+
+Each section of your man page should begin with something similar to the
+following:
+
+ # HEADER NAME
+
+Subsection headers are also understood - use two hashes. Each header must have
+an empty line on either side.
+
+## PARAGRAPHS
+
+Begin a new paragraph with an empty line.
+
+## LINE BREAKS
+
+Insert a line break by ending a line with \+\+.
+
+The result looks++
+like this.
+
+## FORMATTING
+
+Text can be made *bold* or _underlined_ with asterisks and underscores: \*bold\*
+or \_underlined\_. Underscores in the_middle_of_words will be disregarded.
+
+## INDENTATION
+
+You may indent lines with tab characters (*\\t*) to indent them by 4 spaces in
+the output. Indented lines may not contain headers.
+
+ The result looks something like this.
+
+ You may use multiple lines and most _formatting_.
+
+Deindent to return to normal, or indent again to increase your indentation
+depth.
+
+## LISTS
+
+You may start bulleted lists with dashes (-), like so:
+
+```
+- Item 1
+- Item 2
+ - Subitem 1
+ - Subitem 2
+- Item 3
+```
+
+The result looks like this:
+
+- Item 1
+- Item 2
+ - Subitem 1
+ - Subitem 2
+- Item 3
+
+You may also extend long entries onto another line by giving it the same indent
+level, plus two spaces. They will be rendered as a single list entry.
+
+```
+- Item 1 is pretty long so let's
+ break it up onto two lines
+- Item 2 is shorter
+ - But its children can go on
+ for a while
+```
+
+- Item 1 is pretty long so let's
+ break it up onto two lines
+- Item 2 is shorter
+ - But its children can go on
+ for a while
+
+## NUMBERED LISTS
+
+Numbered lists are similar to normal lists, but begin with periods (.) instead
+of dashes (-), like so:
+
+```
+. Item 1
+. Item 2
+. Item 3,
+ with multiple lines
+```
+
+. Item 1
+. Item 2
+. Item 3,
+ with multiple lines
+
+## TABLES
+
+To begin a table, add an empty line followed by any number of rows.
+
+Each line of a table should start with | or : to start a new row or column
+respectively (or space to continue the previous cell on multiple lines),
+followed by [ or - or ] to align the contents to the left, center, or right,
+followed by a space and the contents of that cell. You may use a space instead
+of an alignment specifier to inherit the alignment of the same column in the
+previous row.
+
+The first character of the first row is not limited to | and has special
+meaning. [ will produce a table with borders around each cell. | will produce a
+table with no borders. ] will produce a table with one border around the whole
+table.
+
+To conclude your table, add an empty line after the last row.
+
+```
+[[ *Foo*
+:- _Bar_
+:-
+| *Row 1*
+: Hello
+:] world!
+| *Row 2*
+: こんにちは
+: 世界
+ !
+```
+
+[[ *Foo*
+:- _Bar_
+:-
+| *Row 1*
+: Hello
+:] world!
+| *Row 2*
+: こんにちは
+: 世界
+ !
+
+You may also cause columns to expand to fill the available space with < (left
+align), = (center align), and > (right align), like so:
+
+```
+[[ *Normal column*
+:< Expanded column
+| *Foo*
+: Bar
+```
+
+[[ *Normal column*
+:< Expanded column
+| *Foo*
+: Bar
+
+## LITERAL TEXT
+
+You may turn off scdoc formatting and output literal text with escape codes and
+literal blocks. Inserting a \\ into your source will cause the subsequent symbol
+to be treated as a literal and copied directly to the output. You may also make
+blocks of literal syntax like so:
+
+```
+\```
+_This formatting_ will *not* be interpreted by scdoc.
+\```
+```
+
+These blocks will be indented one level. Note that literal text is shown
+literally in the man viewer - that is, it's not a means for inserting your own
+roff macros into the output. Note that \\ is still interpreted within literal
+blocks, which for example can be useful to output \``` inside of a literal
+block.
+
+## COMMENTS
+
+Lines beginning with ; and a space are ignored.
+
+```
+; This is a comment
+```
+
+# CONVENTIONS
+
+By convention, all scdoc documents should be hard wrapped at 80 columns.
+
+# SEE ALSO
+
+*scdoc*(1)
+
+# AUTHORS
+
+Maintained by Drew DeVault <sir@cmpwn.com>. Up-to-date sources can be found at
+https://git.sr.ht/~sircmpwn/scdoc and bugs/patches can be submitted by email to
+~sircmpwn/public-inbox@lists.sr.ht.
--- /dev/null
+;;; scdoc-mode.el --- Major mode for scdoc files -*- lexical-binding: t; -*-
+;; Copyright 2021 Armaan Bhojwani ISC license.
+
+;; Author: Armaan Bhojwani <me@armaanb.net>
+;; Maintainer: Armaan Bhojwani <me@armaanb.net>
+;; Created: May 30, 2021
+;; Version: 0.0.0
+;; URL: https://git.armaanb.net/scdoc-mode
+
+;;; Commentary:
+;; Inherits mostly from org-mode. auto-fill-mode is reccomended.
+;; Make sure to add the following to your init file:
+;;
+;; (autoload 'scdoc-mode "scdoc-mode" "Major mode for editing scdoc files" t)
+;; (add-to-list 'auto-mode-alist '("\\.scd\\'" . scdoc-mode))
+
+;;; Code:
+
+(defvar scdoc-level-1 'org-level-1)
+(defvar scdoc-level-2 'org-level-2)
+(defvar scdoc-level-3 'org-level-3)
+
+(defvar scdoc-underline-face 'underline)
+
+(defface scdoc-bold-face
+ '((t :weight bold))
+ "Plain bold face."
+ :group 'scdoc-faces)
+(defvar scdoc-bold-face 'scdoc-bold-face)
+
+(defvar scdoc-faces
+ '(("^# .*" . scdoc-level-1) ; Heading 1
+ ("^## .*" . scdoc-level-2) ; Heading 2
+ ("^### .*" . scdoc-level-3) ; Heading 3
+ ("++$" . font-lock-warning-face) ; Line break
+ ("^```$" . font-lock-comment-delimiter-face) ; Literal text
+ ("^; .*" . font-lock-comment-face) ; Comments
+ ("_.*_" . scdoc-underline-face) ; Undsky blerlines
+ ("\*.*\*" . scdoc-bold-face) ; Bold
+ ))
+
+(define-derived-mode scdoc-mode text-mode "scdoc"
+ "Major mode for editing scdoc files."
+ (setq font-lock-defaults '(scdoc-faces)
+ fill-column 80))
+
+(provide 'scdoc-mode)
+;;; scdoc-mode.el ends here
projects / scdoc-mode.git / commitdiff