viktorchernev / describecompiler

A compiler for the Describe Markup Language

Describe Markup Language

Maintaining large data lists, made easy

Describe is a markup language used to write and maintain complex data lists that are compiled on demand to html, xml, sql, json and any other language needed. Describe is simple to use, intuitive and easy to master, and readily extendible.

How to

In order to run the DescribeCompilerCLI.exe you need a Windows PC with DotNet framework version 4.8 or higher. In order to reference the DescribeCompilerAPI.dll in your DotNet projects, you need to target DotNet framework version 4.8 or higher. There are no other dependencies. Also, be sure to check out our wiki for the complete documentation.

0. Set up highlighting

In order to highlight Describe code, you can download the xml files for Notepad++ from the folder Highlighting, or use the instructions provided in said folder to set up your preferred text editor.

1. Write Describe code

Write a title of each list, followed by an arrow -> and the elements, one on a line, separated by comma , and end with a semicolon ;. Add [links] in square brackets, and <tag> items in order to piece lists together. Add additional data as {decorators} in curly brackets. For more info visit the documentation or explore Describe source codes and test cases in this huge collection.

2a. Compile (using CLI)

Run the CLI compiler by specifying the target folder (or file) as first argument and output file (or folder) as second argument. Add options after that, if needed.

2b. Compile (using API)

2c. Compile (using AWS)

3. Result

The final output will depend on the translator used - and you can easily write your own translator, or use the ones that are prebuilt for you. Here we are using a set of particular HTML templates to build a bare-bone website.

Get in touch

• Use GitHub's issue reporter on the right
• Send me an email [email protected] (might take a few days)
• You can reach me on Viber as well: [phone]

Releases

• 0.9.3 (Support for Describe Language v1.0 - Official)
• 0.9.2 (Added features and bugfixes)
• 0.9.1 (Refactoring, added features and bugfixes)
• 0.9 (Initial release - Open beta)

Notes

• We currently have inbuilt translators for HTML and JSON. If you need to target other languages, you'd have to write your own translator - it is very easy. I will give updates here when more translators are available.