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

Switch from Bookdown to MkDocs #59

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
coveralls-upload.json
Expand Down
13 changes: 13 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:
- COMPOSER_ARGS="--no-interaction --ignore-platform-reqs"
- SITE_URL: https://zendframework.github.io/zend-view
- GH_USER_NAME: "Matthew Weier O'Phinney"
- GH_USER_EMAIL: matthew@weierophinney.net
- GH_REF: github.com/zendframework/zend-view.git
- secure: ""

matrix:
fast_finish: true
Expand All @@ -35,6 +42,8 @@ matrix:
env:
- EXECUTE_TEST_COVERALLS=true
- DEPS=locked
- 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:
- DEPS=lastest
Expand Down Expand Up @@ -78,6 +87,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
File renamed without changes.
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-view</h1>

<p>
Zend\View provides the "View" layer of Zend Framework's MVC system.
</p>

<pre><code class="language-bash">$ composer require zendframework/zend-view</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
File renamed without changes.
30 changes: 0 additions & 30 deletions doc/bookdown.json

This file was deleted.

34 changes: 34 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
docs_dir: doc/book
site_dir: doc/html
pages:
- index.md
- "Quick Start": quick-start.md
- View Helpers:
- Intro: helpers.md
- "The PhpRenderer": renderer.php-renderer.md
- "PhpRenderer View Scripts": php-renderer.scripts.md
- "The ViewEvent": view-event.md
- "View Helpers": helpers.md
- BasePath: helpers.base-path.md
- Cycle: helpers.cycle.md
- Doctype: helpers.doctype.md
- "Flash Messenger": helpers.flash-messenger.md
- Gravatar: helpers.gravatar.md
- HeadLink: helpers.head-link.md
- HeadMeta: helpers.head-meta.md
- HeadScript: helpers.head-script.md
- HeadStyle: helpers.head-style.md
- HeadTitle: helpers.head-title.md
- HtmlList: helpers.html-list.md
- HtmlObject: helpers.html-object.md
- Identity: helpers.identity.md
- InlineScript: helpers.inline-script.md
- Json: helpers.json.md
- Partial: helpers.partial.md
- Placeholder: helpers.placeholder.md
- Url: helpers.url.md
- "Advanced usage of helpers": helpers.advanced-usage.md
site_name: zend-view
site_description: zend-view
repo_url: 'https://github.com/zendframework/zend-view'
copyright: 'Copyright (c) 2016 <a href="http://www.zend.com/">Zend Technologies USA Inc.</a>'