This website is built using Docusaurus 2. Pages & components are written in TypeScript, the styles in vanilla CSS with variables using CSS Modules.
yarn
Note. On Linux you may have to install autoconf package to have a successful
installation. On Ubuntu it should be enough to run
sudo apt-get install autoconf command to install the package.
yarn start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
yarn build
This command generates static content into the build directory and can be
served using any static contents hosting service. For that purpose, you can also
use:
yarn serve
We are always happy to have contributions to the project whether it is documentation, bug reports, blog posts, or feedback. To get started with contributing:
- Have a look through GitHub issues.
- Read this section for guidelines.
- For blog posts, follow blog guidelines
- Create a fork of questdb.io and submit a pull request with your proposed changes.
Raise a GH issue for bug report, update request, or tutorial proposal using the respective template.
Check the following guides to ensure that your submission is consistent to our style:
The commit messages must follow the Conventional Commits spec.
To ensure consistency across the document, please follow the templates for:
The coding style rules are defined by Prettier and enforced by Eslint
On top of this, we follow the rules set by the JavaScript Standard Style.
You do not need to run the linting task manually, Webpack will take care of that for you.
We use Husky to automatically deploy git hooks.
On every git commit we check that images added to static/img/* do not exceed
10MB.
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.