# About This CCRMA Documentation

CCRMA Documentation 2019-present.  (For earlier documentation see
[overview](overview.html).)

Auto-generated [index](index.html) and [table of contents](toc.html).

Email `matt` with additions, corrections, questions, requests, etc.

Everything lives in this git repo (for now):
<https://cm-gitlab.stanford.edu/matt/ccrma-docs>

The source files use the
[Markdown](https://daringfireball.net/projects/markdown/)
format. 
There
are
lots
of
great
Markdown
[guides](https://www.markdownguide.org),
tutorials,
[cheatsheets](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
etc.
Also 
[the Pandoc manual](https://pandoc.org/MANUAL.html) 
has lots of great info about Markdown in general and 
[Pandoc's extensions to
Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown) in
specific.

Every `.html` file comes from a corresponding `.md` file that you can
also download; for example this file [README.md](README.md) generates
the output [README.html](README.html).

Diagram source files in formats such as Adobe Illustrator, OmniGraffle are also here.

This repo contains
[bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) 
scripts to build the [html](build.sh) or [pdf](buildpdf.sh) with
[pandoc](https://pandoc.org), [deploy](deploy.sh) to the CCRMA
webserver, and [build the overall table of contents](buildindex.sh).

Here are some of the values and goals embodied in this project:

* Accurate, complete, pertinent information available to CCRMA users.
* No duplication: "factor out" common information to a single location
  and point to there from everywhere relevant.
* Source content stored in simple files not some software's internal
  database
* Simple, lightweight open-source toolchain; not tied to any "heavy"
  infrastructure such as Drupal.
* Structure pages to make it easy to find "how to" information for 
  common tasks. 

This documentation project initiated by Matt Wright in 2019.