issue #106 added toc to documentation

docs/_config.yml

@@ -18,7 +18,7 @@
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
 
-title: YAACC - UPNP Client and Server
+title: YAACC - Android UPNP/DLNA Client and Server
 email:
 description: >- # this means to ignore newlines until "baseurl:"
   The App allows you to play media from UPNP/DLNA devices in your network 
@@ -34,6 +34,7 @@ show_downloads: false
 theme: jekyll-theme-slate
 remote_theme: pages-themes/[email protected]
 markdown: kramdown
+
 plugins:
   - jekyll-remote-theme
   - jekyll-feed

docs/index.md

@@ -1,13 +1,14 @@
 ---
 layout: default
 ---
-# YAACC - Android UPNP/DLNA Client and Server
-
-## TOC
+<!-- markdownlint-configure-file {
+    "first-line-h1": false
+} -->
 
+* TOC
 {:toc}
 
-## Features
+# Features
 
 * UPNP/DLNA Server - share files of your device in the network
 * UPNP/DLNA Client - receive media from other devices on your device
@@ -17,7 +18,7 @@ layout: default
 * Allow sharing of urls and sending them to the current media renderers
 * Use your device as an proxy if your media renderer can't process https media urls
 
-## Usage
+# Usage
 
 On the first screen all UPNP/DLNA servers in your network are listed.
 Select one and the app will atomatically switch to the content tab.
@@ -35,7 +36,7 @@ Normally senders and receivers will appear automatically.
 If not you can use the refresh button at the bottom of
 the sender and receiver tab to trigger a new search for devices.
 
-### Content browsing
+## Content browsing
 
 The content browsing has a bread crumb on the top.
 Behind each content entry different symbols are showing the possible actions:
@@ -49,27 +50,27 @@ At the bottom of the screen the currently selected sender and receiver is displa
 
 ![browse_music_folder](./screenshots/4.1.x/browse_music_folder.png){:height="30%" width="30%"}
 
-### Playing content
+## Playing content
 
 YAACC is able to control an multiple players at the same time.
 For example you are able to stream a image show with background music
-on your device,starting an movie on a TV or play music on a
+on your device, starting a movie on a TV or play music on a
 smart speaker at the same time.
 
 Each player is displayed in the player tab. Depending on the content type
-and if the content is played by YAACC itself or a network device, the player ui differ.
+and if the content is played by YAACC itself or a network device, the player ui differs.
 
 ![browse_player](./screenshots/4.1.x/browse_player.png){:height="30%" width="30%"}
 
 YAACC includes a player for music and image shows.
 Videos are played using a third parties app on the device.
-The app will start automatically if video content is selected for playing
+The video app will start automatically, if video content is selected for playing
 
 ![music_player](./screenshots/4.1.x/music_player.png){:height="30%" width="30%"}
 
 ![image_player_show_menu](./screenshots/4.1.x/image_player_show_menu.png){:height="30%" width="30%"}
 
-### Media server
+## Media server
 
 YAACC includes a media server service, which has to be enabled separately.
 A switch for this is located at the bottom of the server list tab.
@@ -80,30 +81,30 @@ Depending on the configurations for the server in the settings,
 the server service is used as media provider, media renderer or proxy.
 The icons behind the server switch are showing which service is activated.
 
-### Media provider
+## Media provider
 
 If the device is used as media provider, media files stored on the device
 are accessible for other UPNP/DLNA devices in you network.
 At the moment there are no restrictions beside the content type,
 which files are accessible and which are not.
 Be aware of this when activating the service!
 
-### Media renderer
+## Media renderer
 
 This service allows your device acting as an media renderer. Therefore the
 device can be controlled by other UPNP/DLNA controllers in your network
 and receive and play media from UPNP/DLNA servers.
 
-### Media proxy
+## Media proxy
 
-The proxy service is used in the context of sharing urls with YAACC and
+The proxy service is used in the context of sharing URLs with YAACC and
 playing the url on a UPNP/DLNA device in your network. Normally the
-url will directly passed to the rendering device. Sometimes the rendering
+URL will directly passed to the rendering device. Sometimes the rendering
 device is not able to play https urls. Therefore we need to get rid of the
-encryption and provide the content with an unencrypted http url.
-For this the proxy service can be used. In that case the url shared with
+encryption and provide the content with an unencrypted http URL.
+For this the proxy service can be used. In that case the URL shared with
 YAACC will not directly passed to the rendering device. YAACC generates a
-new http based url which points to YAACC and send the to the receiver.
+new http based URL which points to YAACC and send the to the receiver.
 When the content is played YAACC fetches the data from the origin through the
 encrypted https connection an passed the content unencrypted through the http
 connection to the rendering device.