forked from platypush/platypush
[README and wiki changes]
- Renamed _Post-installation_ README section as _Configuration_. - Docs style tweaks for the latest version of the Sphinx theme. - Adapted the docs index to the new structure of the wiki.
This commit is contained in:
parent
f70d352cd7
commit
0baae01ab7
3 changed files with 29 additions and 10 deletions
23
README.md
23
README.md
|
@ -52,7 +52,7 @@
|
||||||
* [Docker](#docker-1)
|
* [Docker](#docker-1)
|
||||||
* [Virtual environment](#virtual-environment)
|
* [Virtual environment](#virtual-environment)
|
||||||
* [Manual installation](#manual-installation-1)
|
* [Manual installation](#manual-installation-1)
|
||||||
- [Post-installation](#post-installation)
|
- [Configuration](#configuration)
|
||||||
* [Configuration file](#configuration-file)
|
* [Configuration file](#configuration-file)
|
||||||
+ [Scripts directory](#scripts-directory)
|
+ [Scripts directory](#scripts-directory)
|
||||||
+ [Splitting configuration on multiple files](#splitting-configuration-on-multiple-files)
|
+ [Splitting configuration on multiple files](#splitting-configuration-on-multiple-files)
|
||||||
|
@ -997,7 +997,7 @@ If you want to customize your installation, or if you need to install
|
||||||
dependencies for a plugin that requires some manual steps, you can check out
|
dependencies for a plugin that requires some manual steps, you can check out
|
||||||
any plugin-specific installation steps from its documentation.
|
any plugin-specific installation steps from its documentation.
|
||||||
|
|
||||||
## Post-installation
|
## Configuration
|
||||||
|
|
||||||
### Configuration file
|
### Configuration file
|
||||||
|
|
||||||
|
@ -1197,8 +1197,7 @@ Several integrations add their own feature-rich panels to the Web view, turning
|
||||||
Platypush into a gateway to all of your services - from Zigbee sensors, to
|
Platypush into a gateway to all of your services - from Zigbee sensors, to
|
||||||
media players and services, to your music cloud, and more.
|
media players and services, to your music cloud, and more.
|
||||||
|
|
||||||
![Screenshot of the media panel, showing search results from multiple sources
|
For example, the music view is available to most of the `music` plugins.
|
||||||
and several supported types of streaming services](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/media-panel-screenshot-1.png)
|
|
||||||
|
|
||||||
![Screenshot of one of the music
|
![Screenshot of one of the music
|
||||||
panels](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/music-panel-screenshot-1.png)
|
panels](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/music-panel-screenshot-1.png)
|
||||||
|
@ -1207,6 +1206,22 @@ panels](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/music-panel-scr
|
||||||
streams across multiple
|
streams across multiple
|
||||||
devices](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/snapcast-panel-screenshot-1.png)
|
devices](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/snapcast-panel-screenshot-1.png)
|
||||||
|
|
||||||
|
Another example is the camera panel, to monitor your cameras, get stand-alone
|
||||||
|
feed URLs, and take photos. This becomes available in the UI if you enable at
|
||||||
|
least a `camera` plugin.
|
||||||
|
|
||||||
|
![Camera panel screenshot
|
||||||
|
1](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/Camera-panel-screenshot-1.png)
|
||||||
|
|
||||||
|
If you enabled at least one local `media` plugin (like `media.vlc`,
|
||||||
|
`media.mplayer` etc.) then you'll also unlock the media UI, which allows you to
|
||||||
|
index, search, view and cast media files under the configured `media_dirs`, and
|
||||||
|
it also integrates with other configured/supported backends such as YouTube,
|
||||||
|
Plex and Jellyfin.
|
||||||
|
|
||||||
|
![Media panel screenshot
|
||||||
|
1](https://platypush-static.s3.nl-ams.scw.cloud/screenshots/Media-panel-screenshot-1.png)
|
||||||
|
|
||||||
### Dashboards
|
### Dashboards
|
||||||
|
|
||||||
The web service also provides means for the user to create [custom
|
The web service also provides means for the user to create [custom
|
||||||
|
|
|
@ -66,7 +66,8 @@ ul.grid li a {
|
||||||
margin-top: 0.5em;
|
margin-top: 0.5em;
|
||||||
}
|
}
|
||||||
|
|
||||||
ul.grid li:hover a {
|
ul.grid li:hover a,
|
||||||
|
ul.grid li:hover a > code {
|
||||||
color: white !important;
|
color: white !important;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -24,9 +24,8 @@ Useful links
|
||||||
============
|
============
|
||||||
|
|
||||||
* The `main page <https://platypush.tech>`_ of the project.
|
* The `main page <https://platypush.tech>`_ of the project.
|
||||||
* The `Gitea page <https://git.platypush.tech/platypush/platypush>`_.
|
* The `source code <https://git.platypush.tech/platypush/platypush>`_.
|
||||||
* The `blog <https://blog.platypush.tech>`_, for articles showing how to use
|
* The `blog <https://blog.platypush.tech>`_.
|
||||||
Platypush in real-world scenarios.
|
|
||||||
|
|
||||||
Wiki
|
Wiki
|
||||||
====
|
====
|
||||||
|
@ -35,10 +34,14 @@ Wiki
|
||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
|
|
||||||
wiki/index
|
wiki/index
|
||||||
|
wiki/Quickstart
|
||||||
wiki/Installation
|
wiki/Installation
|
||||||
|
wiki/Plugins-installation
|
||||||
|
wiki/APIs
|
||||||
|
wiki/Variables
|
||||||
|
wiki/Entities
|
||||||
wiki/Configuration
|
wiki/Configuration
|
||||||
wiki/Installing-extensions
|
wiki/A-full-configuration-example
|
||||||
wiki/A-configuration-example
|
|
||||||
wiki/The-Web-interface
|
wiki/The-Web-interface
|
||||||
|
|
||||||
Reference
|
Reference
|
||||||
|
|
Loading…
Reference in a new issue