https://github.com/digichanges/nexp-docs

Node Experience Documentation
https://github.com/digichanges/nexp-docs

Last synced: 3 days ago
JSON representation

Node Experience Documentation

• Host: GitHub
• URL: https://github.com/digichanges/nexp-docs
• Owner: DigiChanges
• License: mit
• Created: 2022-09-20T13:34:42.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-12-23T22:12:17.000Z (about 1 year ago)
• Last Synced: 2024-04-28T05:17:27.650Z (9 months ago)
• Language: JavaScript
• Homepage: https://nexp.docs.digichanges.com
• Size: 4.52 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Website

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

### Installation

```

$ yarn

```

### Local Development

```

$ 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

```

$ yarn 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 yarn deploy

```

Not using SSH:

```

$ GIT_USER= yarn 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.

## Convert API DOCS

`yarn docusaurus gen-api-docs all`

To Remove all API docs

`yarn docusaurus clean-api-docs all`

## Typesense Config

In order to configure Typesense we need to scrape the site implemented in this way.

In the `typesense` folder we find the basic configuration in `config.json`.

Then we need to have the .env with the environment variables. We find an example in `typesense/.env.example`.

For the following command to work we need to install `jq`.

`docker run -it --net="host" --env-file=./typesense/.env -e "CONFIG=$(cat ./typesense/config.json | jq -r tostring)" typesense/docsearch-scraper`