Some checks failed
Test / cargo test (push) Failing after 40s
- Created `huffman_decompression.md` detailing the Huffman decompression algorithm used in NRes, including context structure, block modes, and decoding methods. - Created `overview.md` for the NRes format, outlining file structure, header details, file entries, and packing algorithms. - Updated `mkdocs.yml` to include new documentation files in the navigation structure.
37 lines
934 B
YAML
37 lines
934 B
YAML
# Project information
|
|
site_name: FParkan
|
|
site_url: https://fparkan.popov.link/
|
|
site_author: Valentin Popov
|
|
site_description: >-
|
|
Utilities and tools for the game “Parkan: Iron Strategy”.
|
|
|
|
# Repository
|
|
repo_name: valentineus/fparkan
|
|
repo_url: https://github.com/valentineus/fparkan
|
|
|
|
# Copyright
|
|
copyright: Copyright © 2023 — 2024 Valentin Popov
|
|
|
|
# Configuration
|
|
theme:
|
|
name: material
|
|
language: en
|
|
palette:
|
|
scheme: slate
|
|
|
|
# Navigation
|
|
nav:
|
|
- Home: index.md
|
|
- Specs:
|
|
- Assets:
|
|
- NRes:
|
|
- Документация по формату: specs/assets/nres/overview.md
|
|
- FRES Декомпрессия: specs/assets/nres/fres_decompression.md
|
|
- Huffman Декомпрессия: specs/assets/nres/huffman_decompression.md
|
|
|
|
# Additional configuration
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/valentineus/fparkan
|