https://github.com/tremor-rs/tremor-www

The source code for the www.tremor.rs website
https://github.com/tremor-rs/tremor-www

docusaurus2 hacktoberfest hacktoberfest2021 prismjs tremor web

Last synced: 4 days ago
JSON representation

The source code for the www.tremor.rs website

• Host: GitHub
• URL: https://github.com/tremor-rs/tremor-www
• Owner: tremor-rs
• License: apache-2.0
• Created: 2021-08-05T13:21:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T04:01:58.000Z (about 2 months ago)
• Last Synced: 2024-09-18T07:10:50.767Z (about 2 months ago)
• Topics: docusaurus2, hacktoberfest, hacktoberfest2021, prismjs, tremor, web
• Language: HTML
• Homepage: https://www.tremor.rs/
• Size: 82.9 MB
• Stars: 14
• Watchers: 7
• Forks: 31
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# 

![License](https://img.shields.io/github/license/tremor-rs/tremor-runtime) 

![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4356/badge)

[![Tremor channel on Discord](https://img.shields.io/badge/chat-on%20discord-%233653a7)](https://discord.com/invite/Wjqu5H9rhQ)

[![Tremor channel on Twitter](https://img.shields.io/badge/tremor--debs-twitter-%231da1f2)](https://twitter.com/TremorDEBS)

[![Netlify Status](https://api.netlify.com/api/v1/badges/f5c25f86-4c18-468e-be20-4408c02ca846/deploy-status)](https://app.netlify.com/sites/tremor-www/deploys)

This project contains the source code for the official [Tremor](https://www.tremor.rs) website.

The main branch between releases can be viewed [here](https://tremor-rs.github.io/tremor-www).

## Installation

This is a step-by-step guideline for installing and running our [Docusaurus](https://docusaurus.io/) (built with React) website:

### Prerequisites/Dependencies

* [Node v16](https://nodejs.org/en/download/package-manager/)

```

npm install

```

* [Rust](https://www.rust-lang.org/tools/install)

* [CMake](https://cmake.org/install/)- 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](https://pkgs.org/download/libssl-dev).

* [libclang-dev](https://pkgs.org/download/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](https://github.com/PrismJS/prism) syntax highlighting engine.

We maintain a [fork](https://github.com/tremor-rs/prism) for Tremor language definitions.

##  Licence 

This repository's content is licensed under the [Apache License 2.0](https://github.com/tremor-rs/tremor-www/blob/main/LICENSE).

Docusaurus is [MIT](https://github.com/facebook/docusaurus/blob/main/LICENSE) Licensed.