About
This is the documentation for the pebble-framework
You may read it on the pebble-framework-docs site
Build
This documentation is built using mkdocs
Install
git clone git@github.com:diversen/pebble-framework-docs.git
cd pebble-framework-docs.git
Create python virtual environment:
virtualenv venv
Activate virtualenv:
source venv/bin/activate
Install mkdocs:
pip install -r requirements.txt
Install simple-file-watch (for adding changed php files to mkdocs):
npm install -g simple-file-watch
Edit and watch
Watch while editing source files src-docs:
source venv/bin/activate
./bin/serve.sh
Live reload at http:/localhost:9000
Build docs
This builds a static HTML site in site.
source venv/bin/activate
./bin/build.sh
Commit to docs/
Shorthand command:
./bin/commit.sh