DescribeCompiler

Describe Compiler

A Powerful Compiler for the Describe Markup Language
The Describe Compiler is designed to help you easily manage and compile complex data lists written in the Describe Markup Language. This innovative tool allows users to convert their data into several formats including HTML, XML, SQL, and JSON, all with simplicity and ease of use in mind.

Key Features

• Intuitive Syntax: Write data lists effortlessly using a simple and intuitive syntax, making it easy for anyone to learn and master the Describe language.
• Robust Extensibility: Customize and extend the compiler to support new target languages or tailor the transpilation process according to project requirements.
• State-of-the-Art Parsing: Built upon the advanced ANTLR 4.13 parsing platform, the Describe Compiler offers a solid grammar structure that ensures reliability, though it is still in beta with ongoing enhancements.
• Multiple Output Formats: Generate outputs in a variety of popular formats, catering to different applications and needs.

How to Use the Describe Compiler

1. Set Up: Download and configure code highlighting XML files for your text editor, enabling you to write Describe code conveniently.
2. Write Your Code: Structure your data by defining titles, elements, links, tags, and decorators using clear syntax:

   Title -> element1, element2, element3;  
   [link]; <tag1>, <tag2>;  
   {decorator}; ~
   

3. Compile Your Data: Use the command line interface (CLI), API, or AWS integration to convert your Describe lists into the desired format.
4. Explore Results: Generate output that suits your needs by utilizing prebuilt translators or creating your custom ones.

Example Compilation with CLI

To run the compiler using the CLI, you can specify commands and options, effortlessly producing the desired output. Visit our wiki for detailed steps on using both the CLI and API methods, as well as AWS integration.

Get Involved

We encourage contributions and feedback as we continue to improve the Describe Compiler. You can report issues directly on GitHub, reach out via email, or connect through Viber.

Support and Sponsorship

If you find the Describe Compiler helpful and wish to support its development, consider contributing through our Patreon or Ko-Fi. Your support allows us to enhance the project and provide better service to users.

Releases

Stay updated with the latest versions of the Describe Compiler, featuring bug fixes, new functionalities, and support for additional output formats. Check the release section on our GitHub page for detailed version notes and download links.