Docs website: update for release of PHPCSUtils 1.0.0-alpha4

.gitignore

@@ -4,6 +4,7 @@ vendor/
 /composer.lock
 /.phpcs.xml
 /phpcs.xml
+/.phpdoc.xml
 /phpdoc.xml
 /phpunit.xml
 /.phpunit.result.cache

phpdoc.dist.xml → .phpdoc.xml.dist

@@ -3,7 +3,7 @@
  configVersion="3"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns="https://www.phpdoc.org"
- xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
+ xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd"
 >
 
  <title>PHPCSUtils</title>
@@ -19,6 +19,15 @@
  <path>phpcsutils-autoload.php</path>
  <path>PHPCSUtils</path>
  </source>
+ <ignore hidden="true" symlinks="true">
+ <path>PHPCSUtils/Internal/**/*</path>
+ </ignore>
+ <visibility>public</visibility>
+ <visibility>protected</visibility>
+ <ignore-tags>
+ <ignore-tag>codeCoverageIgnore</ignore-tag>
+ <ignore-tag>phpcs</ignore-tag>
+ </ignore-tags>
  </api>
  </version>
 

docs/_config.yml

@@ -33,4 +33,34 @@ twitter:
 author:
  twitter: jrf_nl
 
-exclude: ['CNAME', '.gitignore', 'Gemfile', '*.bak', '*.orig', 'vendor']
+# Needed so the select HTML tags do not get removed *sigh*
+commonmark:
+ options: ["SMART", "FOOTNOTES", "UNSAFE"]
+ extensions: ["strikethrough", "autolink", "table"]
+
+# Files to exclude when generating the site.
+exclude:
+ - .sass-cache/
+ - .jekyll-cache/
+ - gemfiles/
+ - Gemfile
+ - Gemfile.lock
+ - node_modules/
+ - vendor/bundle/
+ - vendor/cache/
+ - vendor/gems/
+ - vendor/ruby/
+ - CNAME
+ - CONTRIBUTING.md
+ - LICENSE
+ - README.md
+ - apigen.neon
+ - buildtool.py
+ - Vagrantfile
+ - vagrant-provision.sh
+ - .gitignore
+ - .github
+ - .jekyll-metadata
+ - '*.bak'
+ - '*.orig'
+ - runit.bat

docs/_layouts/default.html

@@ -16,24 +16,24 @@
  <div class="wrapper">
  <header>
  <h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repository_name }}</a></h1>
- 
+
  {% if site.logo %}
  <img src="{{site.logo | absolute_url }}" alt="Logo" />
  {% endif %}
 
  <p>{{ site.description | default: site.github.project_tagline }}</p>
 
- {% if site.github.is_project_page %}
- <p class="view"><a href="{{ site.github.repository_url }}">Visit the Project on GitHub <small>{{ site.github.repository_nwo }}</small></a></p>
- {% endif %}
-
  <p class="docs"><a href="{{ "/phpdoc/index.html" | absolute_url }}">Read the Documentation</a></p>
 
  <div class="install">
  <a href="https://packagist.org/packages/{{ site.phpcsutils.packagist }}">Install using Composer:</a><br>
  <div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>composer require <span class="s">{{ site.phpcsutils.packagist }}</span></code></pre></div></div>
  </div>
 
+ {% if site.github.latest_release.tag_name %}
+ <p>Latest release: <strong>{{ site.github.latest_release.tag_name }}</strong></p>
+ {% endif %}
+
  {% if site.show_downloads %}
  <ul class="downloads">
  <li><a href="{{ site.github.zip_url }}">Download <strong>ZIP File</strong></a></li>
@@ -42,9 +42,9 @@ <h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repo
  </ul>
  {% endif %}
 
- <p><a href="https://twitter.com/share" class="twitter-share-button" data-related="{{ site.twitter.username }}" data-count="none" data-hashtags="{{ site.twitter.hashtags }}">Tweet about it</a></p>
+ <p class="view"><a href="{{ site.github.repository_url }}">Visit the Project on GitHub <small>{{ site.github.repository_nwo }}</small></a></p>
 
- </header>
+  <p><a href="https://twitter.com/share" class="twitter-share-button" data-related="{{ site.twitter.username }}" data-count="none" data-hashtags="{{ site.twitter.hashtags }}">Tweet about it</a></p>
 
  </header>
  <section>

docs/assets/css/style.scss

@@ -89,13 +89,13 @@ p code {
 }
 
 /* FAQ */
-#faq h4 {
+.faq h3 {
  font-size: 18px;
  line-height: 1.1;
  margin-top: 0;
 }
 
-#faq h4::first-letter, #faq h4 + p::first-letter {
+.faq h3::first-letter, .faq h3 + p::first-letter {
  color:#267CB9;
  font-weight: bold;
 }