improve docs

Author: Grotax

.github/workflows/build-docs.yml

@@ -23,7 +23,7 @@ jobs:
         # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          EXTRA_PACKAGES: build-base pygments
           #CUSTOM_DOMAIN: optionaldomain.com
           #CONFIG_FILE: folder/mkdocs.yml
-          #EXTRA_PACKAGES: build-base
           # GITHUB_DOMAIN: github.myenterprise.com

.gitignore

@@ -5,4 +5,6 @@ vendor/
 .php-cs-fixer.cache
 phpunit.xml
 .vscode/
-phpstan.neon
+phpstan.neon
+# mkdocs
+site

README.md

@@ -1,6 +1,9 @@
 # feed-io
 
 [![Packagist](https://img.shields.io/packagist/v/php-feed-io/feed-io.svg)](https://packagist.org/packages/php-feed-io/feed-io)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://php-feed-io.github.io/feed-io/)
+
+**📖 [Read the full documentation](https://php-feed-io.github.io/feed-io/)**
 
 [feed-io](https://github.com/php-feed-io/feed-io) is a PHP library built to consume and serve news feeds. It features:
 

doc/specifications-support.md renamed to docs/specifications-support.md

@@ -4,7 +4,7 @@ This document explains which attributes are supported by feed-io and how to acce
 
 ## top level document : feed (atom) / channel (rss) / top-level (json)
 
-interface : FeedInterface
+**interface : FeedInterface**
 
 | atom            | rss                     | json          | getter          | setter          |
 | --------------- | ----------------------- | ------------- | --------------- | --------------- |
@@ -36,7 +36,7 @@ interface : FeedInterface
 
 ## entry (atom) / item (rss) / item (json)
 
-Interface : ItemInterface
+**Interface : ItemInterface**
 
 | atom                | rss         | json                        | getter          | setter          |
 | ------------------- | ----------- | --------------------------- | --------------- | --------------- |

UPGRADE-3.0.md renamed to docs/upgrades/UPGRADE-3.0.md

@@ -7,6 +7,8 @@ In version 2.x FeedIo::format() returned a DomDocument. Now that feed-io support
 Before :
 
 ```php
+<?php
+
 // Feed creation
 $feed = new \FeedIo\Feed();
 
@@ -27,6 +29,8 @@ Now you get the string :
 
 
 ```php
+<?php
+
 // Feed creation
 $feed = new \FeedIo\Feed();
 
@@ -43,6 +47,8 @@ Instead of a DomDocument.
 Before :
 
 ```php
+<?php
+
 $feedIo = \FeedIo\Factory::create()->getFeedIo();
 
 $result = $feedIo->read('http://php.net/feed.atom');
@@ -54,6 +60,8 @@ $dom = $result->getDocument();
 After :
 
 ```php
+<?php
+
 $feedIo = \FeedIo\Factory::create()->getFeedIo();
 
 $result = $feedIo->read('http://php.net/feed.atom');
@@ -62,7 +70,7 @@ $dom = $result->getDocument()->getDOMDocument();
 
 ```
 
-This is because Result::getDocument()'s return value is a wrapper for both XML and JSON streams.
+This is because `Result::getDocument()`'s return value is a wrapper for both XML and JSON streams.
 
 ### That's it
 

UPGRADE-4.0.md renamed to docs/upgrades/UPGRADE-4.0.md

@@ -6,18 +6,20 @@ The major change in version 4.0 is the full migration to PHP 7.1. It has an impa
 
 From now on, all types are explicits in method signatures. It has an impact on classes that implements :
 
- - \FeedIo\FeedInterface 
- - \FeedIo\Feed\ItemInterface
- - \FeedIo\Feed\NodeInterface
- - \FeedIo\Feed\ElementsAwareInterface
- - \FeedIo\Feed\Item\AuthorInterface
- - \FeedIo\Feed\Item\MediaInterface
- - \FeedIo\Feed\Node\CategoryInterface
- - \FeedIo\Feed\Node\ElementInterface
+ - `\FeedIo\FeedInterface`
+ - `\FeedIo\Feed\ItemInterface`
+ - `\FeedIo\Feed\NodeInterface`
+ - `\FeedIo\Feed\ElementsAwareInterface`
+ - `\FeedIo\Feed\Item\AuthorInterface`
+ - `\FeedIo\Feed\Item\MediaInterface`
+ - `\FeedIo\Feed\Node\CategoryInterface`
+ - `\FeedIo\Feed\Node\ElementInterface`
 
 For instance, `FeedIo\FeedInterface::setUrl($url)` becomes :
 
 ```php
+<?php
+
     /**
      * @param string $url
      * @return FeedInterface
@@ -27,6 +29,8 @@ For instance, `FeedIo\FeedInterface::setUrl($url)` becomes :
 As a consequence, you need to adapt any class that implements `FeedIo\FeedInterface` according to the new signature : 
 
 ```php
+<?php
+
     /**
      * @param string $url
      * @return FeedInterface
@@ -41,6 +45,8 @@ As a consequence, you need to adapt any class that implements `FeedIo\FeedInterf
 becomes : 
 
 ```php
+<?php
+
     /**
      * @param string $url
      * @return FeedInterface

UPGRADE-5.0.md renamed to docs/upgrades/UPGRADE-5.0.md

@@ -1,7 +1,26 @@
 site_name: feed-io Documentation
 theme:
   name: material
+  features:
+    - content.code.copy
+
 
 nav:
   - Home: index.md
   - Code Quality: codecontributions.md
+  - Specification: specifications-support.md
+  - Upgrade:
+      - Upgrade to v3: upgrades/UPGRADE-3.0.md
+      - Upgrade to v4: upgrades/UPGRADE-4.0.md
+      - Upgrade to v5: upgrades/UPGRADE-5.0.md
+      - Upgrade to v6: upgrades/UPGRADE-6.0.md
+
+markdown_extensions:
+  - pymdownx.highlight:
+      use_pygments: true
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences