Merge pull request #12 from froschdesign/docs/switch-from-bookdown-to…

…-mkdocs

[Docs] Switch from Bookdown to MkDocs

.gitignore

@@ -7,6 +7,8 @@
 .*.un~
 nbproject
 tmp/
+doc/html/
+zf-mkdoc-theme/
 
 clover.xml
 composer.lock

.travis.yml

@@ -10,6 +10,16 @@ branches:
 cache:
   directories:
     - $HOME/.composer/cache
+    - $HOME/.local
+    - zf-mkdoc-theme
+
+env:
+  global:
+    - SITE_URL: https://zendframework.github.io/zend-permissions-rbac
+    - GH_USER_NAME: "Matthew Weier O'Phinney"
+    - GH_USER_EMAIL: matthew@weierophinney.net
+    - GH_REF: github.com/zendframework/zend-permissions-rbac.git
+    - secure: ""
 
 matrix:
   fast_finish: true
@@ -20,6 +30,8 @@ matrix:
     - php: 5.6
       env:
         - EXECUTE_TEST_COVERALLS=true
+        - DEPLOY_DOCS="$(if [[ $TRAVIS_BRANCH == 'master' && $TRAVIS_PULL_REQUEST == 'false' ]]; then echo -n 'true' ; else echo -n 'false' ; fi)"
+        - PATH="$HOME/.local/bin:$PATH"
     - php: 7
     - php: hhvm 
   allow_failures:
@@ -42,6 +54,10 @@ script:
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/phpunit --coverage-clover clover.xml ; fi
   - if [[ $EXECUTE_TEST_COVERALLS != 'true' ]]; then ./vendor/bin/phpunit ; fi
   - if [[ $EXECUTE_CS_CHECK == 'true' ]]; then ./vendor/bin/php-cs-fixer fix -v --diff --dry-run ; fi
+  - if [[ $DEPLOY_DOCS == "true" && "$TRAVIS_TEST_RESULT" == "0" ]]; then wget -O theme-installer.sh "https://raw.githubusercontent.com/zendframework/zf-mkdoc-theme/master/theme-installer.sh" ; chmod 755 theme-installer.sh ; ./theme-installer.sh ; fi
+
+after_success:
+  - if [[ $DEPLOY_DOCS == "true" ]]; then echo "Preparing to build and deploy documentation" ; ./zf-mkdoc-theme/deploy.sh ; echo "Completed deploying documentation" ; fi
 
 after_script:
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/coveralls ; fi

doc/book/index.html

@@ -0,0 +1,12 @@
+<div class="container">
+    <div class="jumbotron">
+        <h1>zend-permissions-rbac</h1>
+
+        <p>
+            The Zend\Permissions\Rbac component provides a lightweight
+            role-based access control.
+        </p>
+
+        <pre><code class="language-bash">$ composer require zendframework/zend-permissions-rbac</code></pre>
+    </div>
+</div>

doc/book/index.md

@@ -0,0 +1 @@
+../../README.md

mkdocs.yml

@@ -0,0 +1,12 @@
+docs_dir: doc/book
+site_dir: doc/html
+pages:
+    - index.md
+    - Intro: intro.md
+    - Reference:
+        - Methods: methods.md
+        - Examples: examples.md
+site_name: zend-permissions-rbac
+site_description: zend-permissions-rbac
+repo_url: 'https://github.com/zendframework/zend-permissions-rbac'
+copyright: 'Copyright (c) 2016 <a href="http://www.zend.com/">Zend Technologies USA Inc.</a>'