Skip to content

Home

Jump to bottom
cainsusk edited this page Nov 12, 2023 · 2 revisions

Contents

This Repository stores important COMPSA documentation including:

  • The COMPSA Constitution
  • General Assembly Minutes
  • Portfolio Operation & Policy Manuals

Motivation

This repository was created with the intention to provide COMPSA with a plain-text way to store & collaborate on important documentation.

The reason for this is, relying on what is essentially 90s desktop publishing software (Google Docs, Word, etc.), for documentation causes the problem of readability -- where without proprietary software, documentation cannot be reliably written or read.

Furthermore, for important documentation such as this, it is important to understand the reasoning behind previous decisions. Git provides a perfect platform for this, as commit messages & other documentation captures this information. Additionally, GitHub provides great tools for tracking desired changes (Issues) to capture even more information.

Therefore, this repository contains plain-text (MarkDown) files, storing COMPSA documentation.

MarkDown

MarkDown is a standard for formatting documents using plain-text. This standard is used by numerous platforms (GitHub, Slack, Discord) to render rich-text (formatted text) from plain-text. For example:

# This is a heading

## This is a subheading

### etc...

This is normal text, and `this is code text`, 
this is *italic text*, and this is **bold text**

> and this is a callout

And theres much more !

You can learn more about the MarkDown syntax here.

Presentation

To make the documentation presentable & printable, this repository requires the use of pandoc, which is a universal document coverter. Pandoc has the ability to compile Markdown to pdf, html, and many more!

To use pandoc on your computer, first install it using a package manager (brew, apt, etc...) and then run the command:

pandoc [filename].md -o [newname].[filetype]

Where [filename].md is the input, -o signifies the output file, and [newname] is the name of the converted file, and [filetype] is the desired format of the output file.

Note: Because pandoc is used, many different syntaxes can be used in markdown files, including LaTeX and HTML.

Sources

This document was inspired by the video and associated text by No Boilerplate:

Clone this wiki locally