Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

tigrisdata/tigris-os-docs

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

736 Commits
736 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Code Style: prettier

Tigris Documentation

This website is built using Docusaurus 3, a modern static website generator.

Prerequisites

  • Node.js version >= 18 or above (which can be checked by running node -v).
  • Python
  • pip

Installation

npm install

Configuration

Copy the example local configuration for use in development.

cp .env.local.example .env.local

Local development

npm run dev

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

Serve

npm run serve

This command generates static content into the build directory and can be served using any static contents hosting service.

Contributing

Linting with Prettier

The coding style rules are defined by Prettier and enforced by Eslint

For VSCode you can enable format on save within the Prettier VSCode extension.

Linting with ESLint

We use ESlink for static code analysis.

Git Hooks

We use pre-commit to automatically setup and run git hooks.

On every git commit we check the code quality using Prettier and ESlint.

Releases

Packages

Used by

Contributors

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.