-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #141 from PHPCSStandards/docs-site/convert-to-usin…
…g-ghpages-jekyll Docs website: convert to using Jekyll
- Loading branch information
Showing
33 changed files
with
430 additions
and
1,897 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| _site/* | ||
| Gemfile.lock | ||
| .sass-cache | ||
| *.gem |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| source 'https://rubygems.org' | ||
|
|
||
| gem "github-pages", group: :jekyll_plugins do | ||
| gem 'jekyll-commonmark-ghpages' | ||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| baseurl: / | ||
| highlighter: rouge | ||
| markdown: CommonMarkGhPages | ||
| encoding: UTF-8 | ||
| theme: jekyll-theme-minimal | ||
| repository: "PHPCSStandards/PHPCSUtils" | ||
| github: [metadata] | ||
| url: "https://phpcsutils.com" | ||
|
|
||
| plugins: | ||
| - jekyll-github-metadata | ||
| - jemoji | ||
| - jekyll-mentions | ||
| - jekyll-seo-tag | ||
| - jekyll-sitemap | ||
|
|
||
| phpcsutils: | ||
| packagist: phpcsstandards/phpcsutils | ||
|
|
||
| # Theme info. | ||
| title: PHPCSUtils | ||
| description: "A suite of utility functions for use with PHP_CodeSniffer." | ||
| logo: | ||
| show_downloads: false | ||
| google_analytics: | ||
|
|
||
| # SEO info. | ||
| tagline: "PHPCSUtils: A suite of utility functions for use with PHP_CodeSniffer." | ||
| twitter: | ||
| username: jrf_nl | ||
| card: summary | ||
| hashtags: PHPCSUtils | ||
| author: | ||
| twitter: jrf_nl | ||
|
|
||
| exclude: ['CNAME', '.gitignore', 'Gemfile', '*.bak', '*.orig'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="{{ site.lang | default: "en-US" }}"> | ||
| <head> | ||
| <meta charset="UTF-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
|
|
||
| {% seo %} | ||
| <link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}"> | ||
| <link rel="stylesheet" href="{{ "/assets/css/syntax.css?v=" | append: site.github.build_revision | relative_url }}"> | ||
| <!--[if lt IE 9]> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script> | ||
| <![endif]--> | ||
| </head> | ||
| <body> | ||
| <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.show_downloads %} | ||
| <ul class="downloads"> | ||
| <li><a href="{{ site.github.zip_url }}">Download <strong>ZIP File</strong></a></li> | ||
| <li><a href="{{ site.github.tar_url }}">Download <strong>TAR Ball</strong></a></li> | ||
| <li><a href="{{ site.github.repository_url }}">View On <strong>GitHub</strong></a></li> | ||
| </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> | ||
|
|
||
| </header> | ||
|
|
||
| </header> | ||
| <section> | ||
|
|
||
| {{ content }} | ||
|
|
||
| </section> | ||
| <footer> | ||
| {% if site.github.is_project_page %} | ||
| <p>This project is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p> | ||
| {% endif %} | ||
| <p><small>Hosted on GitHub Pages — Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p> | ||
| </footer> | ||
| </div> | ||
|
|
||
| <script src="{{ "/assets/js/scale.fix.js" | relative_url }}"></script> | ||
| {% if site.google_analytics %} | ||
| <script> | ||
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ | ||
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), | ||
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) | ||
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); | ||
| ga('create', '{{ site.google_analytics }}', 'auto'); | ||
| ga('send', 'pageview'); | ||
| </script> | ||
| {% endif %} | ||
|
|
||
| <script type="text/javascript"> | ||
| !function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs'); | ||
| </script> | ||
| </body> | ||
| </html> |
Oops, something went wrong.