Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
txoof committed Mar 20, 2024
1 parent 8553b25 commit 9f75a26
Show file tree
Hide file tree
Showing 6 changed files with 64 additions and 64 deletions.
26 changes: 13 additions & 13 deletions paperpi/plugins/lms_client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,51 +111,51 @@ DATA KEYS AVAILABLE FOR USE IN LAYOUTS PROVIDED BY paperpi.plugins.lms_client.lm

## Provided Layouts

layout: **album_art_title**

![sample image for plugin album_art_title](./lms_client.album_art_title-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> album_art_title**

![sample image for plugin album_art_title](./lms_client.album_art_title-RGB-sample.png)


layout: **cover_art_only**
layout: **album_art_title**

![sample image for plugin cover_art_only](./lms_client.cover_art_only-L-sample.png)
![sample image for plugin album_art_title](./lms_client.album_art_title-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> cover_art_only**

![sample image for plugin cover_art_only](./lms_client.cover_art_only-RGB-sample.png)


layout: **layout**
layout: **cover_art_only**

![sample image for plugin layout](./lms_client.layout-L-sample.png)
![sample image for plugin cover_art_only](./lms_client.cover_art_only-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> layout**

![sample image for plugin layout](./lms_client.layout-RGB-sample.png)


layout: **three_rows_text_only**
layout: **layout**

![sample image for plugin three_rows_text_only](./lms_client.three_rows_text_only-L-sample.png)
![sample image for plugin layout](./lms_client.layout-L-sample.png)


layout: **two_column_three_row**
layout: **three_rows_text_only**

![sample image for plugin two_column_three_row](./lms_client.two_column_three_row-L-sample.png)
![sample image for plugin three_rows_text_only](./lms_client.three_rows_text_only-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> two_column_three_row**

![sample image for plugin two_column_three_row](./lms_client.two_column_three_row-RGB-sample.png)


layout: **two_column_three_row**

![sample image for plugin two_column_three_row](./lms_client.two_column_three_row-L-sample.png)


layout: **two_rows_text_only**

![sample image for plugin two_rows_text_only](./lms_client.two_rows_text_only-L-sample.png)
Expand Down
22 changes: 11 additions & 11 deletions paperpi/plugins/met_no/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,43 +88,43 @@ DATA KEYS AVAILABLE FOR USE IN LAYOUTS PROVIDED BY paperpi.plugins.met_no.met_no
## Provided Layouts
layout: **layout**
![sample image for plugin layout](./met_no.layout-L-sample.png)
layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> layout**
![sample image for plugin layout](./met_no.layout-RGB-sample.png)
layout: **three_column_icon_wind_temp_precip**
layout: **layout**
![sample image for plugin three_column_icon_wind_temp_precip](./met_no.three_column_icon_wind_temp_precip-L-sample.png)
![sample image for plugin layout](./met_no.layout-L-sample.png)
layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> three_column_icon_wind_temp_precip**
![sample image for plugin three_column_icon_wind_temp_precip](./met_no.three_column_icon_wind_temp_precip-RGB-sample.png)
layout: **three_row_icon_wind_temp**
layout: **three_column_icon_wind_temp_precip**
![sample image for plugin three_row_icon_wind_temp](./met_no.three_row_icon_wind_temp-L-sample.png)
![sample image for plugin three_column_icon_wind_temp_precip](./met_no.three_column_icon_wind_temp_precip-L-sample.png)
layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> three_row_icon_wind_temp**
![sample image for plugin three_row_icon_wind_temp](./met_no.three_row_icon_wind_temp-RGB-sample.png)
layout: **two_column_icon_wind_temp_precip**
layout: **three_row_icon_wind_temp**
![sample image for plugin two_column_icon_wind_temp_precip](./met_no.two_column_icon_wind_temp_precip-L-sample.png)
![sample image for plugin three_row_icon_wind_temp](./met_no.three_row_icon_wind_temp-L-sample.png)
layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> two_column_icon_wind_temp_precip**
![sample image for plugin two_column_icon_wind_temp_precip](./met_no.two_column_icon_wind_temp_precip-RGB-sample.png)
layout: **two_column_icon_wind_temp_precip**
![sample image for plugin two_column_icon_wind_temp_precip](./met_no.two_column_icon_wind_temp_precip-L-sample.png)
22 changes: 11 additions & 11 deletions paperpi/plugins/reddit_quote/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,45 +59,45 @@ DATA KEYS AVAILABLE FOR USE IN LAYOUTS PROVIDED BY paperpi.plugins.reddit_quote.

## Provided Layouts

layout: **layout**

![sample image for plugin layout](./reddit_quote.layout-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> layout**

![sample image for plugin layout](./reddit_quote.layout-RGB-sample.png)


layout: **quote**
layout: **layout**

![sample image for plugin quote](./reddit_quote.quote-L-sample.png)
![sample image for plugin layout](./reddit_quote.layout-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> quote**

![sample image for plugin quote](./reddit_quote.quote-RGB-sample.png)


layout: **quote_inverse**
layout: **quote**

![sample image for plugin quote_inverse](./reddit_quote.quote_inverse-L-sample.png)
![sample image for plugin quote](./reddit_quote.quote-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> quote_inverse**

![sample image for plugin quote_inverse](./reddit_quote.quote_inverse-RGB-sample.png)


layout: **quote_small_screen**
layout: **quote_inverse**

![sample image for plugin quote_small_screen](./reddit_quote.quote_small_screen-L-sample.png)
![sample image for plugin quote_inverse](./reddit_quote.quote_inverse-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> quote_small_screen**

![sample image for plugin quote_small_screen](./reddit_quote.quote_small_screen-RGB-sample.png)


layout: **quote_small_screen**

![sample image for plugin quote_small_screen](./reddit_quote.quote_small_screen-L-sample.png)


## Additional Plugin Information
This plugin is based on the [veebch/stonks](https://github.com/veebch/stonks) and [veebch/edify](https://github.com/veebch/edify) application. The code is mostly rewritten, but the basic layout and much of the logic is borrowed.
26 changes: 13 additions & 13 deletions paperpi/plugins/slideshow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,56 +71,56 @@ DATA KEYS AVAILABLE FOR USE IN LAYOUTS PROVIDED BY paperpi.plugins.slideshow.sli

## Provided Layouts

layout: **image_only_centered_blackbkground**

![sample image for plugin image_only_centered_blackbkground](./slideshow.image_only_centered_blackbkground-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> image_only_centered_blackbkground**

![sample image for plugin image_only_centered_blackbkground](./slideshow.image_only_centered_blackbkground-RGB-sample.png)


layout: **image_only_centered_whitebkground**
layout: **image_only_centered_blackbkground**

![sample image for plugin image_only_centered_whitebkground](./slideshow.image_only_centered_whitebkground-L-sample.png)
![sample image for plugin image_only_centered_blackbkground](./slideshow.image_only_centered_blackbkground-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> image_only_centered_whitebkground**

![sample image for plugin image_only_centered_whitebkground](./slideshow.image_only_centered_whitebkground-RGB-sample.png)


layout: **image_time_centered_blackbkground**
layout: **image_only_centered_whitebkground**

![sample image for plugin image_time_centered_blackbkground](./slideshow.image_time_centered_blackbkground-L-sample.png)
![sample image for plugin image_only_centered_whitebkground](./slideshow.image_only_centered_whitebkground-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> image_time_centered_blackbkground**

![sample image for plugin image_time_centered_blackbkground](./slideshow.image_time_centered_blackbkground-RGB-sample.png)


layout: **image_time_centered_whitebkground**
layout: **image_time_centered_blackbkground**

![sample image for plugin image_time_centered_whitebkground](./slideshow.image_time_centered_whitebkground-L-sample.png)
![sample image for plugin image_time_centered_blackbkground](./slideshow.image_time_centered_blackbkground-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> image_time_centered_whitebkground**

![sample image for plugin image_time_centered_whitebkground](./slideshow.image_time_centered_whitebkground-RGB-sample.png)


layout: **layout**
layout: **image_time_centered_whitebkground**

![sample image for plugin layout](./slideshow.layout-L-sample.png)
![sample image for plugin image_time_centered_whitebkground](./slideshow.image_time_centered_whitebkground-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> layout**

![sample image for plugin layout](./slideshow.layout-RGB-sample.png)


layout: **layout**

![sample image for plugin layout](./slideshow.layout-L-sample.png)


## Additional Plugin Information

### Configuration Options:
Expand Down
14 changes: 7 additions & 7 deletions paperpi/plugins/system_info/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,26 +84,26 @@ DATA KEYS AVAILABLE FOR USE IN LAYOUTS PROVIDED BY paperpi.plugins.system_info.s

## Provided Layouts

layout: **basic_layout**

![sample image for plugin basic_layout](./system_info.basic_layout-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> basic_layout**

![sample image for plugin basic_layout](./system_info.basic_layout-RGB-sample.png)


layout: **layout**
layout: **basic_layout**

![sample image for plugin layout](./system_info.layout-L-sample.png)
![sample image for plugin basic_layout](./system_info.basic_layout-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> layout**

![sample image for plugin layout](./system_info.layout-RGB-sample.png)


layout: **layout**

![sample image for plugin layout](./system_info.layout-L-sample.png)


## Additional Plugin Information

The following data are returned by the plugin for use in layouts:
Expand Down
18 changes: 9 additions & 9 deletions paperpi/plugins/word_clock/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,33 +50,33 @@ DATA KEYS AVAILABLE FOR USE IN LAYOUTS PROVIDED BY paperpi.plugins.word_clock.wo

## Provided Layouts

layout: **layout**

![sample image for plugin layout](./word_clock.layout-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> layout**

![sample image for plugin layout](./word_clock.layout-RGB-sample.png)


layout: **word_clock**
layout: **layout**

![sample image for plugin word_clock](./word_clock.word_clock-L-sample.png)
![sample image for plugin layout](./word_clock.layout-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> word_clock**

![sample image for plugin word_clock](./word_clock.word_clock-RGB-sample.png)


layout: **word_clock_lg**
layout: **word_clock**

![sample image for plugin word_clock_lg](./word_clock.word_clock_lg-L-sample.png)
![sample image for plugin word_clock](./word_clock.word_clock-L-sample.png)


layout: **<font color="red">R</font><font color="green">G</font><font color="blue">B</font> word_clock_lg**

![sample image for plugin word_clock_lg](./word_clock.word_clock_lg-RGB-sample.png)


layout: **word_clock_lg**

![sample image for plugin word_clock_lg](./word_clock.word_clock_lg-L-sample.png)


0 comments on commit 9f75a26

Please sign in to comment.