Build tools

Adds build tools that:

- Download required assets in order to build the site.
- Creates the component list to include in the landing page.
- Cleans up when done.

Author: weierophinney

Makefile

@@ -0,0 +1,45 @@
+# Makefile for ZF documentation landing page
+#
+# General usage:
+#
+#     make all
+#
+# Once done, run:
+#
+#     git add -A .
+#     git commit
+#     git push origin
+#
+# After running the `make all` command, you might want to preview the
+# results before committing:
+#
+#     php -S 0:8000 -t .
+
+.PHONY : all ready clean mkdocs build
+
+all: build
+
+zf-mkdoc-theme:
+	- git clone git://github.com/zendframework/zf-mkdoc-theme.git
+
+ready:
+	- rm -Rf css img index.html js search sitemap.xml docs/html
+	- mkdir -p docs/html
+
+zf-component-list.json:
+	- wget https://zendframework.github.io/zf-mkdoc-theme/scripts/zf-component-list.json
+
+docs/book/index.html:
+	- php docs/scripts/prepare_component_list.php
+
+mkdocs: zf-mkdoc-theme zf-component-list.json docs/book/index.html
+	- ./zf-mkdoc-theme/build.sh
+	- cp -a docs/html/* .
+	- rm index.html.dist
+
+build: ready mkdocs clean
+
+clean:
+	- rm -Rf zf-mkdoc-theme
+	- rm zf-component-list.json
+	- rm docs/book/index.html

docs/book/css/site.css

@@ -7,3 +7,15 @@
   color: white;
   border-bottom: 0;
 }
+
+.component h4 {
+  color: #018D74;
+  font-size: 1.5em;
+}
+
+.package {
+  margin-top: -0.5em;
+  padding-top: 0;
+  font-size: 0.8em;
+  color: #666666;
+}

docs/book/index.html renamed to docs/book/index.html.dist

@@ -0,0 +1,58 @@
+<?php
+
+const TEMPLATE = <<< 'EOT'
+<div class="row">
+  <h2>Components</h2>
+
+  %components%
+</div>
+
+EOT;
+
+const PACKAGE_TEMPLATE = <<< 'EOT'
+  <div class="component col-xs-12 col-md-6">
+    <h4><a href="%href%">%name%</a></h4>
+    <p class="package">%package%</p>
+    <p>%description%</p>
+  </div>
+
+EOT;
+
+$root      = realpath(getcwd());
+$listFile  = sprintf('%s/zf-component-list.json', $root);
+$srcPath   = sprintf('%s/docs/book', $root);
+$distPath  = sprintf('%s/index.html.dist', $srcPath);
+$indexPath = sprintf('%s/index.html', $srcPath);
+
+if (! is_readable($listFile)) {
+    fwrite(STDERR, "Unable to locate zf-component-list.json in root directory; did you run 'make'?\n");
+    exit(1);
+}
+
+if (! is_readable($distPath)) {
+    fwrite(STDERR, "Unable to locate docs/book/index.html.dist; did you run this script from the correct directory?\n");
+    exit(1);
+}
+
+$json = file_get_contents($listFile);
+$packages = json_decode($json, true);
+
+$componentMarkup = [];
+foreach ($packages as $package) {
+    // @codingStandardsIgnoreStart
+    $componentMarkup []= str_replace(
+        [       '%href%',         '%name%',         '%package%',         '%description%'],
+        [$package['url'], $package['name'], $package['package'], $package['description']],
+        PACKAGE_TEMPLATE
+    );
+}
+$componentMarkup = implode("\n\n", $componentMarkup);
+
+$markup = str_replace('%components%', $componentMarkup, TEMPLATE);
+
+copy($distPath, $indexPath);
+$fh = fopen($indexPath, 'a');
+fwrite($fh, $markup);
+fclose($fh);
+
+printf("Generated %s\n", $indexPath);