Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/phcode-dev/docs

Phoenix documentation docs.phcode.dev
https://github.com/phcode-dev/docs

Last synced: about 1 month ago
JSON representation

Phoenix documentation docs.phcode.dev

Awesome Lists containing this project

README

        

## Welcome to Phoenix Documentation

This repository hosts the code for https://docs.phcode.dev/ . Please contribute
to this repo for helping the Phoenix/Brackets community.

## License

CC BY License Copyright (c) 2022-present, core.ai

# Website

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

### Installation

```
$ npm install
```

### Local Development

```
$ npm run 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

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