https://github.com/neurotech-hq/sarufi-docs

Sarufi API documentation
https://github.com/neurotech-hq/sarufi-docs

sarufi sarufi-documentation

Last synced: about 1 month ago
JSON representation

Sarufi API documentation

• Host: GitHub
• URL: https://github.com/neurotech-hq/sarufi-docs
• Owner: Neurotech-HQ
• License: mit
• Created: 2022-09-18T13:50:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-21T19:47:41.000Z (6 months ago)
• Last Synced: 2024-06-23T06:13:48.749Z (6 months ago)
• Topics: sarufi, sarufi-documentation
• Language: JavaScript
• Homepage: https://docs.sarufi.io/
• Size: 70.8 MB
• Stars: 10
• Watchers: 0
• Forks: 11
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sarufi Documentation Website

The Sarufi documentation website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

Contributions are welcome.

## Getting Started

For small changes, fork the repository, edit it on GitHub and make a pull request.  

For more extensive changes:

- fork the repository

- clone your fork onto your local machine

- make your changes

- preview your changes using [yarn](https://www.npmjs.com/package/yarn)

- once satisfied with your changes, push to your fork and make a pull request

### Installation

``` bash

git clone https://github.com/YOUR_USERNAME/sarufi-docs

cd sarufi-docs

yarn

```

### Local Development

``` bash

yarn start

```

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

``` bash

yarn build

```

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