aboutsummaryrefslogtreecommitdiff
path: root/README.org
blob: d215a9d7ff7d8e553ff8291ee96e8c0ffecc343c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
#+TITLE: Org-Templates
#+AUTHOR: Christian Cleberg
#+OPTIONS: toc:nil

This repository contains reusable Org-mode templates intended for structured
documentation of various workflows. Templates are grouped by domain under the
=templates/= directory.

See the live preview of these templates exported to HTML at
[[https://org-templates.cleberg.net][org-templates.cleberg.net]]. A set of
minimal CSS rules are applied from the =assets/styles.css= file.

To generate the HTML files locally, run the provided =export.sh= script from a
command line shell. This script processes the Org files and produces the HTML
exports. No additional configuration is required.

* Directory Structure

The repository is organized as follows:

- =templates/audit/= contains templates for IT auditing and review.
- =templates/finance/= contains templates for budgeting and expense tracking.
- =templates/generic/= contains general-purpose templates for journaling,
  planning, and note-taking.
- =templates/infrastructure/= contains templates for documenting systems,
  networks, and architecture.
- =templates/ops/= contains templates for operational tasks such as runbooks and
  change management.
- =templates/programming/= contains templates for development tasks such as code
  review and bug tracking.
- =templates/security/= contains templates for incident response and threat
  modeling.

* Usage Instructions

Templates are written in standard Org-mode format and can be inserted manually
or integrated with Emacs systems such as =org-capture= or =yasnippet=. No
special tooling is required.

* Contribution Policy

Contributions are accepted in the form of additional templates, modifications to
existing templates, or structural improvements to the repository. Submissions
must maintain the plain text, structured, and minimal nature of the project.

* Repository Listing

A directory listing is available in the =tree.txt= file at the root of the
repository.