Merge pull request #79 from froschdesign/docs/switch-from-bookdown-to-mkdocs

[Docs] Switch from Bookdown to MkDocs configuration

Author: weierophinney

.gitignore

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

.travis.yml

@@ -10,10 +10,17 @@ branches:
 cache:
   directories:
     - $HOME/.composer/cache
+    - $HOME/.local
+    - zf-mkdoc-theme
 
 env:
   global:
     - TESTS_ZEND_VALIDATOR_ONLINE_ENABLED=true
+    - SITE_URL: https://zendframework.github.io/zend-validator
+    - GH_USER_NAME: "Matthew Weier O'Phinney"
+    - GH_USER_EMAIL: [email protected]
+    - GH_REF: github.com/zendframework/zend-validator.git
+    - secure: ""
 
 matrix:
   fast_finish: true
@@ -28,6 +35,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: 5.6
       env:
         - SERVICE_MANAGER_VERSION="^2.7.5"
@@ -61,6 +70,11 @@ script:
   - 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 [[ $EXECUTE_HOSTNAME_CHECK == "true" && $TRAVIS_PULL_REQUEST == "false" ]]; then php bin/update_hostname_validator.php --check-only; 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,11 @@
+<div class="container">
+    <div class="jumbotron">
+        <h1>zend-validator</h1>
+
+        <p>
+            The Zend\Validator component provides a set of commonly needed validators.
+        </p>
+
+        <pre><code class="language-bash">$ composer require zendframework/zend-validator</code></pre>
+    </div>
+</div>

doc/book/index.md

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

mkdocs.yml

@@ -0,0 +1,41 @@
+docs_dir: doc/book
+site_dir: doc/html
+pages:
+    - index.md
+    - Intro: intro.md
+    - Reference:
+        - "Standard Validation Classes": set.md
+        - Validators
+            - Barcode: barcode.md
+            - Between: between.md
+            - Callback: callback.md
+            - CreditCard: credit-card.md
+            - Date: date.md
+            - "Db\RecordExists and Db\NoRecordExists": db.md
+            - Digits: digits.md
+            - EmailAddress: email-address.md
+            - "File Validation Classes": file.md
+            - GreaterThan: greater-than.md
+            - Hex: hex.md
+            - Hostname: hostname.md
+            - Iban: iban.md
+            - Identical: identical.md
+            - InArray: in-array.md
+            - Ip: ip.md
+            - Isbn: isbn.md
+            - IsInstanceOf: isinstanceof.md
+            - LessThan: less-than.md
+            - NotEmpty: not-empty.md
+            - Regex: regex.md
+            - Sitemap: sitemap.md
+            - Step: step.md
+            - StringLength: string-length.md
+            - Timezone: timezone.md
+            - Uri: uri.md
+        - "Validator Chains": validator-chains.md
+        - "Writing Validators": writing-validators.md
+        - "Validation Messages": validation-messages.md
+site_name: zend-validator
+site_description: zend-validator
+repo_url: 'https://github.com/zendframework/zend-validator'
+copyright: 'Copyright (c) 2016 <a href="http://www.zend.com/">Zend Technologies USA Inc.</a>'