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
- Get a text editing environment with support for org mode.
Options include the obvious GNU Emacs but also
VS Code
with an extension orVim
by committing heresy. - Be familiar with Git.
Contributing
- Clone the GitHub repo.
- In the
content/
folder, create a file with a sensible name (in a new branch). Add the following as a header of the file.
#+TITLE: <Page Title> #+DATE: <YYYY-MM-DD> #+AUTHOR: Your Full Name #+EMAIL: netid@uic.edu
- Write out your contribution article in normal
org-mode
syntax. - Test changes locally by running
./build.sh
. The results are in thepublic/
folder. - 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.