Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1.17 KB

README.md

File metadata and controls

28 lines (22 loc) · 1.17 KB
Raw

OrgFlow Docs

Running Locally

docs.orgflow.io is powered by DocFx.

  1. Make sure you have NPM available on your device.
  2. Make sure you have a copy of DocFx v2 available on your device.
  3. Clone this repository.
  4. From the root of the repository, run the following commands: 
    npm install leap/
npm build leap/
docfx build --serve docfx.json
    A local copy of the site will be available at http://localhost:8080.
  5. Update the content locally running site by running docfx build docfx.json after making changes.

With VS Code

There are a number of tasks available to help make development with VS Code simpler:

  1. Make sure you have NPM available on your device.
  2. Make sure you have a copy of DocFx v2 available on your device.
  3. Clone this repository and open in VS Code.
  4. Run npm install.
  5. Run the build & serve task. This builds the site and starts it at http://localhost:8080.
  6. Use the build task to update the content of the site after you have made changes.