Contributing to this website.

Table of Contents

Introduction

This website uses GNU Emacs and org-mode to manage content. Org mode files (.org) are converted to HTML files (.html) by Emacs. It is surprisingly easy to contribute to this website.

Prerequisites

  1. Get a text editing environment with support for org mode. Options include the obvious GNU Emacs but also VS Code with an extension or Vim by committing heresy.
  2. Be familiar with Git.

Contributing

  1. Clone the GitHub repo.
  2. In the content/ folder, create a file with a sensible name (in a new branch).
  3. Add the following as a header of the file.

    #+TITLE: <Page Title>
    #+DATE: <YYYY-MM-DD>
    #+AUTHOR: Your Full Name
    #+EMAIL: netid@uic.edu
    
  4. Write out your contribution article in normal org-mode syntax.
  5. Test changes locally by running ./build.sh. The results are in the public/ folder.
  6. Push and create a Pull Request!

Licensing

By contributing, you agree to release your work under the same license as the entire project. This project is licensed MIT and may be changed by the LUG Administration with or without notice.

Date: 2023-01-02 Mon 00:00

Created: 2023-01-18 Wed 22:04

Emacs 27.1 (Org mode 9.3)