Skip to content
This repository has been archived by the owner on Jan 31, 2020. It is now read-only.

[Docs] Switch from Bookdown to MkDocs configuration #79

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
.*.un~
nbproject
tmp/
doc/html/
zf-mkdoc-theme/

clover.xml
composer.lock
Expand Down
14 changes: 14 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"
Expand Down Expand Up @@ -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
11 changes: 11 additions & 0 deletions doc/book/index.html
Original file line number Diff line number Diff line change
@@ -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>
1 change: 1 addition & 0 deletions doc/book/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../README.md
41 changes: 41 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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>'