This project contains the source code for the official Tremor website.

The main branch between releases can be viewed here.

Installation

This is a step-by-step guideline for installing and running our Docusaurus (built with React) website:

Prerequisites/Dependencies

• Node v16

npm install

• Rust
• CMake- an open-source, cross-platform family of tools designed to build, test and package software. CMake will help in the compilation process, and to generate native make.
• libssl-dev.
• libclang-dev- Clang is a compiler front-end.

Development

To generate a dynamic site and configuration:

Run make clean to get rid of object and executable files that had been created in the meantime so as to get a fresh start and make a clean build. Sometimes, the compiler may link or compile files incorrectly; you only need to recompile the files you changed and link the newly created object files with the pre-existing ones.

make clean

Run make to generate the site files for Tremor stdlib and cli and also produce the default config file for Docusaurus (docusaurus.config.js) with the right navigation references to the generated stdlib files.

make

Running the Website

To preview your changes as you edit the files, you can run a local development server that will serve your Tremor website and reflect the latest changes:

npm run start

By default, a browser window serving the website will open at http://localhost:3000.

Syntax Highlighting

Docusaurus uses the Prism syntax highlighting engine.

We maintain a fork for Tremor language definitions.

Licence

This repository's content is licensed under the Apache License 2.0.

Docusaurus is MIT Licensed.