Neutralinojs website

This repository contains the source code of the Neutralinojs website including the Markdown-based documentation. This website is built using Docusaurus 2, a modern static website generator.

Developer guide

Prerequisites

Node.js: Use older version of Node.js (around v16.19.0). Use Node Version Manager (NVM) for easy switching between Node.js versions.

To install and use the correct Node.js version, execute:

nvm install
nvm use

We'll soon fix this issue and let contributors run this project on latest Node versions.

Installation

yarn install

Local Development

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.

Build

yarn build

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

Deployment

Our GitHub Actions deployment workflow automatically deploys the last commit in the main branch to the GitHub Pages service.

License

MIT

Contributing to Neutralinojs

We really appreciate your code contributions. Please read this contribution guide before sending a pull request. Thanks for your contributions. Check out FAQs in case of general queries.

Contributors

Made with contributors-img.