https://github.com/lenra-io/docs

LENRA components documentation
https://github.com/lenra-io/docs

hacktoberfest

Last synced: about 2 months ago
JSON representation

LENRA components documentation

• Host: GitHub
• URL: https://github.com/lenra-io/docs
• Owner: lenra-io
• License: mit
• Created: 2022-02-28T09:11:28.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-17T14:55:15.000Z (9 months ago)
• Last Synced: 2024-04-18T15:25:42.355Z (9 months ago)
• Topics: hacktoberfest
• Language: CSS
• Homepage:
• Size: 3.25 MB
• Stars: 5
• Watchers: 0
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Documentation

Lenra's documentation web site

## Development

To launch the server in dev mode, run the following commands:

```bash

# Install dependencies

npm i

# Load external API pages

npm run load-api

# Start the server

npm start

```

## Release

To release a new version of the documentation, run the following commands:

```bash

# Install dependencies

npm i

# Load external API pages

npm run load-api

# Build the static site

npm run build

# Build the docker image

docker build -t lenra/docs:local .

```

You can then run the docker image with:

```bash

docker run -p 8080:8080 lenra/docs:local

```

and access the documentation at http://localhost:8080

The search engine is only available with the release version.