This repository contains the documentation for the frontend javascript framework Footwork.
For more details, see the main website.
This documentation is based on MkDocs, a markdown based documentation generator.
-
Clone the repo from GitHub:
git clone https://github.com/footworkjs/footwork-documentation.git cd footwork-documentation
-
Install Python PIP and mkdocs:
You will need to use python pip (pip installation) to install MkDocs (http://www.mkdocs.org/#installation) and its related material theme.
-
Install python pip (Ubuntu shown, see pip installation for more/other info):
sudo apt-get install python-pip
-
Install mkdocs:
pip install mkdocs
-
Install and build the footwork-mkdocs-material theme:
Note that this will need to be installed at the same level directory as the main documentation folder (this folder is pointed at from mkdocs.yml via the theme_dir option if you want it in a different place):
git clone https://github.com/footworkjs/footwork-mkdocs-material.git -b footwork cd footwork-mkdocs-material pip install pymdown-extensions npm install gulp
- Install Node.js (if needed):
This is platform specific. Your OS may already include it, however if not please see: Installing Node.
- Install gulp and bower globally (if needed):
-
gulp
sudo npm install -g gulp-cli
-
bower
sudo npm install -g bower
-
Install local npm and bower based dependencies:
npm install && bower install
-
Build or run the site:
Note that you will need to run the default gulp
task to build the initial CSS assets, then you can use the watch task afterwards.
-
Build the site and its assets, generated output in
/site
gulp
-
Run watch process which rebuilds css/html and auto-refreshes your browser when pointed at: http://localhost:8000
# Local access via: http://localhost:8000 gulp watch
...you can also run it on a different port like this:
# Local access via: http://localhost:9000 gulp watch --port 9000
A quick copy/paste for building a release and (tar.gz) archive it:
# Run from root of this repo
VERSION=2.0.0 && gulp && tar czf footwork-docs-${VERSION}.tar.gz --transform "s,^,footwork-docs-${VERSION}/," -C ./site ./
And then to extract, link, and make zip in production environment:
# Upload the above archive to footwork-documentation-site/public/release and run this command from it:
VERSION=2.0.0 && tar -zxf footwork-docs-${VERSION}.tar.gz && rm -f ${VERSION} && ln -s footwork-docs-${VERSION} ${VERSION} && zip -r footwork-docs-${VERSION}.zip footwork-docs-${VERSION}
MIT license - http://www.opensource.org/licenses/mit-license.php