Lady’s Gitweb - Codemark/blob - README.lesml

   1 #!lesml@en$
   2 ## SPDX-FileCopyrightText: 2026 Lady <https://www.ladys.computer/about/#lady>
   3 ## SPDX-License-Identifier: CC-BY-SA-4.0
   4
   5 ⁌ 🧮🖍 Codemark
   6
   7 ☞︎A documentation generator.☜︎
   8
   9 The goal of 🧮🖍 Codemark is to make it easy to convert source files
  10   in various programming languages into {🔗LesM·L
  11   files<https://git.ladys.computer/LesML>} which document them.
  12 This is done “simply”; i·e with shell scripting and the programs
  13   already installed on your (Posix‐compliant) computer.
  14 The broader intention is that this can serve as a component in a
  15   Make‐based documentation generation program for a repository of
  16   various files.
  17
  18 § Usage
  19
  20 »|sh$ sh ./sh/codemark.sh [--] [source_file] [syntax]
  21
  22 • If `source_file´ is not provided, it is taken to be `-´ (standard
  23   input).
  24
  25 • If `syntax´ is not provided, it is taken from the file extension of
  26   `source_file´.
  27
  28 The makefile in `make/documentation.make´ provides an example (minimal)
  29   build system which makes use of the 🧮🖍 Codemark script.
  30
  31 § Description
  32
  33 The vast majority of markup capabilities are provided by Sed programs,
  34   which are run on source files and whose output is the result.
  35 Each source format supports a syntax for “documentation comments”,
  36   which are essentially unwrapped and treated as the main Les·M·L text
  37   of the file.
  38 The remaining lines are formatted as preformatted text according to the
  39   conventions described in `PROFILE.lesml´.
  40
  41 With·in a documentation comment, source text in any supported syntax
  42   `SYNTAX´ may be quoted using the line leader `»|SYNTAX$ ´.
  43
  44 Supported syntaxes are exactly those which have corresponding files in
  45   the `sed/SYNTAXES´ directory in this repository, plus the special
  46   format `lesml´.
  47