Enchantrix/docs/index.md

# Welcome to Enchantrix

Enchantrix is a Go-based crypto library and miner application. This documentation provides information on how to use the various features of the Enchantrix library.

## Trix File Format

The `.trix` file format is a generic and flexible binary container for storing an arbitrary data payload alongside structured metadata. For more information, see the [Trix File Format](./trix_format.md) page.

## CLI Reference

Enchantrix provides a command-line tool for encoding, decoding, and hashing data. See the [CLI Reference](./cli.md) for detailed usage instructions.

## Examples

The following pages provide examples of how to use the Enchantrix library:

*   [Trix & Sigil Chaining](./trix_and_sigils.md)
*   [Hashing](./hashing.md)
*   [Checksums](./checksums.md)
*   [RSA](./rsa.md)
*   [PGP](./pgp.md)
*   [Standalone Sigils](./standalone_sigils.md)
feat: Add MkDocs website with GitHub Pages deployment This commit adds a new documentation website built with MkDocs and the Material theme. The website includes pages for: - Trix & Sigil Chaining - Hashing - Checksums - RSA - Standalone Sigils A GitHub Actions workflow is also included to automatically build and deploy the site to GitHub Pages when changes are merged into the main branch. 2025-11-03 01:02:49 +00:00			`# Welcome to Enchantrix`

			`Enchantrix is a Go-based crypto library and miner application. This documentation provides information on how to use the various features of the Enchantrix library.`

			`## Trix File Format`

			The `.trix` file format is a generic and flexible binary container for storing an arbitrary data payload alongside structured metadata. For more information, see the [Trix File Format](./trix_format.md) page.

docs: add CLI reference, PGP examples, and detailed sigil list 2025-11-25 00:00:24 +00:00			`## CLI Reference`

			`Enchantrix provides a command-line tool for encoding, decoding, and hashing data. See the [CLI Reference](./cli.md) for detailed usage instructions.`

feat: Add MkDocs website with GitHub Pages deployment This commit adds a new documentation website built with MkDocs and the Material theme. The website includes pages for: - Trix & Sigil Chaining - Hashing - Checksums - RSA - Standalone Sigils A GitHub Actions workflow is also included to automatically build and deploy the site to GitHub Pages when changes are merged into the main branch. 2025-11-03 01:02:49 +00:00			`## Examples`

			`The following pages provide examples of how to use the Enchantrix library:`

			`* [Trix & Sigil Chaining](./trix_and_sigils.md)`
			`* [Hashing](./hashing.md)`
			`* [Checksums](./checksums.md)`
			`* [RSA](./rsa.md)`
docs: add CLI reference, PGP examples, and detailed sigil list 2025-11-25 00:00:24 +00:00			`* [PGP](./pgp.md)`
feat: Add MkDocs website with GitHub Pages deployment This commit adds a new documentation website built with MkDocs and the Material theme. The website includes pages for: - Trix & Sigil Chaining - Hashing - Checksums - RSA - Standalone Sigils A GitHub Actions workflow is also included to automatically build and deploy the site to GitHub Pages when changes are merged into the main branch. 2025-11-03 01:02:49 +00:00			`* [Standalone Sigils](./standalone_sigils.md)`