About lex

lex is a plain text document format that combines the simplicity of plain text notes with the power of structured, parsable markup. It is designed to grow with your ideas, from initial sketches to polished documents, without requiring migration between tools or formats.

Project Status

lex is currently under active development. The project is implementing the core “trifecta” of structural elements:

• Paragraphs
• Sessions (hierarchical sections)
• Lists

The format is being built incrementally with a focus on clear specifications, robust parsing, and comprehensive testing.

Implementation

The reference implementation is written in Rust, providing:

• A complete parser with a five-phase pipeline
• Comprehensive test suite
• Support for the core structural elements
• Foundation for future extensions

Repository

The project is open source and hosted on GitHub:

• Repository: https://github.com/arthur-debert/lex
• Issues: https://github.com/arthur-debert/lex/issues
• Pull Requests: https://github.com/arthur-debert/lex/pulls

Documentation Structure

The repository includes:

• Specifications: Versioned language specifications in docs/specs/
• Architecture: System design documentation in docs/architecture.lex
• Samples: Example documents demonstrating various features
• Tests: Comprehensive test suite ensuring correctness

Contributing

Contributions are welcome! Please check the repository for current issues, ongoing work, and contribution guidelines.

Philosophy

lex follows a philosophy of simplicity and clarity:

• Documentation is written in lex format (dogfooding)
• Straight, objective, and informative style
• Focus on practical usability over theoretical perfection
• Incremental development with clear versioning

License

Please refer to the repository for licensing information.