[TASK] Fix syntax highlighting in Changelog for ImplementStaticRoutes 09/58409/2
authorDaniel Siepmann <daniel.siepmann@typo3.org>
Thu, 27 Sep 2018 08:39:14 +0000 (10:39 +0200)
committerTymoteusz Motylewski <t.motylewski@gmail.com>
Thu, 27 Sep 2018 09:28:59 +0000 (11:28 +0200)
Use yaml as default highlighting. Add markup for code blocks.

Also add highlighting for file names.

Resolves: #86214
Releases: master
Change-Id: I716c9bf80f86e3188409d173d767469a84a28e82
Reviewed-on: https://review.typo3.org/58409
Reviewed-by: Richard Haeser <richard@maxserv.com>
Tested-by: Richard Haeser <richard@maxserv.com>
Reviewed-by: Mathias Brodala <mbrodala@pagemachine.de>
Tested-by: TYPO3com <no-reply@typo3.com>
Tested-by: Mathias Brodala <mbrodala@pagemachine.de>
Reviewed-by: Tymoteusz Motylewski <t.motylewski@gmail.com>
Tested-by: Tymoteusz Motylewski <t.motylewski@gmail.com>

index 33e94a1..ecd1684 100644 (file)
@@ -1,4 +1,5 @@
 .. include:: ../../Includes.txt
+.. highlight:: yaml
 Feature: #86214 - Implement static routes
@@ -15,10 +16,10 @@ should be reachable at /robots.txt on each site. You can now add a static route
 define which content should be delivered.
 The TYPO3 SEO extension provides a sitemap for TYPO3 out of the box, but it's only reachable at a specific page type.
-To enable easier access you can now configure a static route `sitemap.xml` that maps to that page type (see example
+To enable easier access you can now configure a static route :file:`sitemap.xml` that maps to that page type (see example
-Routes can be configured as toplevel files (as in the `sitemap.xml` and `robots.txt` case) but may also be configured
+Routes can be configured as toplevel files (as in the :file:`sitemap.xml` and :file:`robots.txt` case) but may also be configured
 to deeper route paths (`my/deep/path/to/a/static/text` for example). Matching is done on the full path but without any
@@ -31,17 +32,17 @@ There are two options: deliver static text or resolve a TYPO3 URL.
 The `staticText` option allows to deliver simple text content. The text can be added through a text field directly in
-the site configuration. This is suitable for files like `robots.txt` or `humans.txt`.
+the site configuration. This is suitable for files like :file:`robots.txt` or :file:`humans.txt`.
-YAML Configuration Example :: yaml
+YAML Configuration Example::
-      route: robots.txt
-      type: staticText
-      content: |
-        Sitemap: https://example.com/sitemap.xml
-        User-agent: *
-        Allow: /
-        Disallow: /forbidden/
+   route: robots.txt
+   type: staticText
+   content: |
+     Sitemap: https://example.com/sitemap.xml
+     User-agent: *
+     Allow: /
+     Disallow: /forbidden/
 TYPO3 URL (t3://)
@@ -49,16 +50,16 @@ TYPO3 URL (t3://)
 The type `uri` for TYPO3 URL provides the option to render either a file, page or url. Internally a request to the
 file or URL is done and its content delivered.
-YAML Configuration Examples :: yaml
+YAML Configuration Examples::
-    -
-      route: sitemap.xml
-      type: uri
-      source: 't3://page?uid=1&type=1533906435'
-    -
-      route: favicon.ico
-      type: uri
-      source: 't3://file?uid=77'
+   -
+     route: sitemap.xml
+     type: uri
+     source: 't3://page?uid=1&type=1533906435'
+   -
+     route: favicon.ico
+     type: uri
+     source: 't3://file?uid=77'