https://github.com/neptun-software/neptun.tools.docs
The documentation website for the neptun-cli-tool and the neptun webinterface.
https://github.com/neptun-software/neptun.tools.docs
cli docs tools webui
Last synced: 9 months ago
JSON representation
The documentation website for the neptun-cli-tool and the neptun webinterface.
- Host: GitHub
- URL: https://github.com/neptun-software/neptun.tools.docs
- Owner: neptun-software
- Created: 2024-02-26T20:52:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-16T18:46:03.000Z (9 months ago)
- Last Synced: 2025-03-16T19:44:50.821Z (9 months ago)
- Topics: cli, docs, tools, webui
- Language: JavaScript
- Homepage: https://neptun-tools-docs.pages.dev
- Size: 5.16 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NeptunAI Documentation
## Includes
- [diagrams](https://docusaurus.io/docs/api/themes/@docusaurus/theme-mermaid)
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
```
npm install
```
### 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
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true npm run deploy
```
Not using SSH:
```
$ GIT_USER= npm run deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.