aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2025-08-16 10:35:36 -0400
committerEugene Triguba <hello@eugenetriguba.com>2025-08-16 10:35:36 -0400
commitd493e0df6386713905e93379b019c40a74b013e3 (patch)
tree8819c18ca19c529cfc45bc9a9429aa326296dbc6 /docs
parentAdjust mkdocs config (diff)
downloadconfig-file-d493e0df6386713905e93379b019c40a74b013e3.zip
Add supported formats
Diffstat (limited to 'docs')
-rw-r--r--docs/supported-formats.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/supported-formats.md b/docs/supported-formats.md
new file mode 100644
index 0000000..09197c0
--- /dev/null
+++ b/docs/supported-formats.md
@@ -0,0 +1,13 @@
+# Supported Formats
+
+Config File supports four popular configuration file formats.
+
+## Format Overview
+
+| Format | Extensions | Specification | Library Used | Extras Required |
+|----------|------------|---------------|--------------|-----------------|
+| **INI** | `.ini` | No official spec | [configparser](https://docs.python.org/3/library/configparser.html) (built-in) | None |
+| **JSON** | `.json` | [RFC 7159](https://tools.ietf.org/html/rfc7159.html)
+| [json](https://docs.python.org/3/library/json.html) (built-in) | None |
+| **YAML** | `.yaml`, `.yml` | [YAML 1.2](https://yaml.org/spec/1.2/spec.html) | `PyYAML` | `yaml` |
+| **TOML** | `.toml` | [TOML v1.0.0]() | [tomlkit](https://github.com/python-poetry/tomlkit) | `toml` |