diff options
| author | Eugene Triguba <hello@eugenetriguba.com> | 2025-08-16 10:35:36 -0400 |
|---|---|---|
| committer | Eugene Triguba <hello@eugenetriguba.com> | 2025-08-16 10:35:36 -0400 |
| commit | d493e0df6386713905e93379b019c40a74b013e3 (patch) | |
| tree | 8819c18ca19c529cfc45bc9a9429aa326296dbc6 | |
| parent | Adjust mkdocs config (diff) | |
| download | config-file-d493e0df6386713905e93379b019c40a74b013e3.zip | |
Add supported formats
| -rw-r--r-- | docs/supported-formats.md | 13 | ||||
| -rw-r--r-- | mkdocs.yaml | 10 |
2 files changed, 22 insertions, 1 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` | diff --git a/mkdocs.yaml b/mkdocs.yaml index 4617ffd..119285c 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -7,7 +7,7 @@ repo_name: eugenetriguba/config-file repo_url: https://git.sr.ht/~eugenetriguba/config-file theme: - name: terminal + name: terminal plugins: - search @@ -21,3 +21,11 @@ nav: - Home: index.md - Getting Started: - Installation: installation.md + # - Quick Start: quick-start.md + # - User Guide: + # - Basic Usage: usage/basic-usage.md + # - Advanced Features: usage/advanced-features.md + # - Error Handling: usage/error-handling.md + # - API Reference: api-reference.md + - Supported Formats: supported-formats.md + # - License: license.md |