Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

169 Commits

MPL-2.0-or-later = DocMatrix OpenSSF Best Practices

Palimpsest

License & Philosophy

This project must declare MPL-2.0-or-later for platform/tooling compatibility.

Philosophy: Palimpsest. The MPL-2.0 (PMPL) text is provided in license/MPL-2.0.txt, and the canonical source is the palimpsest-license repository.

Cross-platform document editor with format tabs (TXT/MD/ADOC/DJOT/ORG/RST/TYP). Gossamer GUI + Ada TUI. Graph visualization, OCR, TTS/STT, Nickel pipelines.

Features

  • Format Tabs - View and edit the same document in multiple markup formats

  • Unified AST - Lossless conversion between formats

  • GUI - Gossamer with ReScript frontend

  • TUI - Ada with AdaCurses for terminal usage

  • Graph Visualization - ArangoDB for document relationships

  • Accessibility - OCR, TTS, STT support

  • Pipelines - Nickel-based import/export transformations

Supported Formats

FormatDescription

TXT

Plain text

MD

Markdown (CommonMark)

ADOC

AsciiDoc

DJOT

Djot markup

ORG

Org-mode

RST

reStructuredText

TYP

Typst

Quick Start

# Check dependencies
just deps
# Build all components
just build
# Run GUI
just run-gui
# Run TUI
just run-tui

Architecture

crates/
├── formatrix-core/ # AST, parsers, renderers
├── formatrix-gui/ # Gossamer commands
├── formatrix-db/ # ArangoDB client
└── formatrix-pipeline/ # Nickel executor
tui/src/ # Ada TUI source
ui/src/ # ReScript components
pipelines/ # Nickel pipeline definitions
container/ # Wolfi container configs

Development

Prerequisites

  • Rust (stable)

  • Deno

  • GNAT + gprbuild (for TUI)

  • GTK4 + WebKit2GTK (for GUI)

Build Commands

just build # Build all
just build-core # Build Rust core only
just build-tui # Build Ada TUI only
just build-ui # Build ReScript UI only
just test# Run all tests
just fmt # Format all code
just lint # Lint all code

Containers

just container-build # Build Wolfi image
just compose-up # Start with ArangoDB
just container-run-tui # Run TUI in container

RSR Compliance

This project follows the Rhodium Standard Repositories specification:

Automation scripts from hyperpolymath/scripts:

ScriptPurpose

asdfman.sh

Manage asdf plugins and versions

init_bashrc_three_ply.sh

Modular bashrc setup (three-layer architecture)

k-check.sh

Kinoite cluster validation

k-intune.sh

Kinoite tuning scripts

langstrap.sh

Mass language install utilities

sysenv.sh

System environment setup

touchscreen_hunter_killer.sh

Touchscreen calibration/management

These scripts follow the same language policy (Bash, Rust, ReScript, Deno, Gleam, Guile Scheme) and multi-forge mirroring strategy.

License

MPL-2.0 with Palimpsest philosophy.

About

Cross-platform document editor with format tabs

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages