Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 3 additions & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,6 @@
.env.test.local
.env.production.local

*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
42 changes: 40 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
# OpenEBS Documentation
# Website

This directory contains the content and source of the OpenEBS Docs.
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Installation

```bash
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.

## Deployment

Using SSH:

```bash
USE_SSH=true yarn deploy
```

Not using SSH:

```bash
GIT_USER=<Your GitHub username> 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.
3 changes: 0 additions & 3 deletions docs/babel.config.js

This file was deleted.

185 changes: 0 additions & 185 deletions docs/docusaurus.config.js

This file was deleted.

Loading
Loading