Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neutralinojs/neutralinojs.github.io
The official website and documentation of Neutralinojs
https://github.com/neutralinojs/neutralinojs.github.io
css hacktoberfest html javascript landing-page neutralinojs website
Last synced: about 1 month ago
JSON representation
The official website and documentation of Neutralinojs
- Host: GitHub
- URL: https://github.com/neutralinojs/neutralinojs.github.io
- Owner: neutralinojs
- License: mit
- Created: 2018-05-15T09:45:58.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T08:31:28.000Z (5 months ago)
- Last Synced: 2024-04-13T21:19:46.618Z (5 months ago)
- Topics: css, hacktoberfest, html, javascript, landing-page, neutralinojs, website
- Language: JavaScript
- Homepage: https://neutralino.js.org
- Size: 15.7 MB
- Stars: 241
- Watchers: 13
- Forks: 117
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/about-neutralinojs.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Neutralinojs website
This repository contains the source code of the Neutralinojs website including the Markdown-based documentation. This website is built using [Docusaurus 2](https://v2.docusaurus.io/), 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)](https://github.com/nvm-sh/nvm) for easy switching between Node.js versions.
To install and use the correct Node.js version, execute:
```bash
nvm install
nvm use
```
We'll soon fix this issue and let contributors run this project on latest Node versions.
### Installation
```console
yarn install
```
### Local Development
```console
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
```console
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](https://github.com/neutralinojs/neutralinojs.github.io/blob/main/.github/workflows/deploy.yml) automatically deploys the last commit in the `main` branch to the GitHub Pages service.
### License
[MIT](LICENSE)
### Contributing to Neutralinojs
We really appreciate your code contributions. Please read [this contribution guide](https://neutralino.js.org/docs/contributing/framework-developer-guide#contribution-guidelines) before sending a pull request. Thanks for your contributions. Check out [FAQs](http://neutralino.js.org/docs/contributing/frequently-asked-questions) in case of general queries.
### Contributors
Made with [contributors-img](https://contrib.rocks).