Neutralinojs Website

Neutralinojs Website is the official Docusaurus-powered source repository behind the Neutralinojs project site at neutralino.js.org, serving as both the project's public documentation and a working template for a markdown-driven static documentation site.

What is Neutralinojs Website?

Neutralinojs Website is the source code repository for the official Neutralinojs website, built entirely with Docusaurus, a modern static website generator. It takes Markdown-based documentation content and produces a static, deployable website, with a developer workflow for local development, production builds, and automated deployment through GitHub Actions. The repository is maintained by the Neutralinojs open-source community and is released under the MIT license.

Key features

• Docusaurus framework — The entire site is built on Docusaurus, enabling versioned documentation, markdown pages, and static rendering without a backend server.
• Markdown documentation — All documentation is written in Markdown, making content easy to edit, review, and maintain through plain-text files.
• Live local development — Running yarn start starts a local development server with hot reload, so changes are reflected live in the browser without a server restart.
• Static production build — The yarn build command generates the full website into a build directory that can be hosted on any static content hosting service.
• Automated GitHub Pages deployment — A GitHub Actions workflow automatically deploys the latest commit on the main branch to GitHub Pages, eliminating manual publishing steps.
• Contributor listing — A contributors section dynamically displays project contributors using the contrib.rocks service, spotlighting every person who has contributed to the site.
• Contribution guidelines — The repository includes a link to the Neutralinojs framework developer contribution guide and a FAQ for general questions, lowering the barrier for new contributors.

Who is Neutralinojs Website for?

• Neutralinojs maintainers — They use this repository to keep the official project documentation accurate, current, and deployed live at neutralino.js.org.
• Open-source contributors — Developers who want to contribute to Neutralinojs documentation can clone the repo, run yarn install, and start editing Markdown files with a live preview.
• Docusaurus learners — Anyone interested in seeing a real-world Docusaurus setup can study this repository to understand how to structure docs, automate deployments, and manage site metadata.

What can you do with Neutralinojs Website?

• Documentation maintainers: Update or add Markdown pages and run yarn build to generate a fresh static site for review before deployment.
• Project owners: Copy the repository structure to launch a Docusaurus documentation site with GitHub Pages deployment already configured.
• New contributors: Submit pull requests against the documentation and see your avatar appear in the contributors list once merged.

The developer guide in the repository covers installing the right Node.js LTS version via nvm, installing dependencies with yarn install, running the dev server, and creating a production build. Deployment is fully automated, requiring no manual server configuration.