Drarig29 / brackets-docs

Contains the documentation for all brackets-* related projects

brackets-docs

This repository contains the documentation for all brackets-* related projects.

It is built with MkDocs and the "Material for MkDocs" theme.

It also contains type references for brackets-manager.js and brackets-viewer.js, built with TypeDoc.

Writing

To update the versions of the dependencies (manager, viewer and model), run:

make update

To run the documentation locally, you can use Docker:

make && docker run --rm -it -p 8000:8000 \
  -v `pwd`/mkdocs.yml:/docs/mkdocs.yml \
  -v `pwd`/docs:/docs/docs \
  build-docs:latest