Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 1 KB

README.md

File metadata and controls

54 lines (35 loc) · 1 KB

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, 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=<Your GitHub username> 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.