diff options
-rw-r--r-- | docs/developer/Article-Enhancers.md | 27 | ||||
-rw-r--r-- | docs/developer/External-Api.md (renamed from docs/developer/external-api-v2/README.md) | 0 | ||||
-rw-r--r-- | docs/developer/Plugins.md (renamed from docs/developer/plugins/README.md) | 0 | ||||
-rw-r--r-- | docs/developer/README.md | 6 |
4 files changed, 33 insertions, 0 deletions
diff --git a/docs/developer/Article-Enhancers.md b/docs/developer/Article-Enhancers.md new file mode 100644 index 000000000..7d2613427 --- /dev/null +++ b/docs/developer/Article-Enhancers.md @@ -0,0 +1,27 @@ +# Article Enhancers +You can enhance the feed download and rendering process in the following ways: + +* Adding custom full text rules +* Adding custom CSS + +In any case, please consider **contributing your changes back** to either [picoFeed](https://github.com/fguillot/picoFeed) or [News](https://github.com/owncloud/news/blob/master/css/custom.css) + +## Custom Full Text Feed Rules +The News app uses [picoFeed](https://github.com/fguillot/picoFeed) for parsing RSS and Atom feeds. It also provides a web scraper which can be extended with custom rules. If you want to extend these rules or add your own ones, follow [the picoFeed documentation](https://github.com/fguillot/picoFeed/blob/master/docs/grabber.markdown#how-to-write-a-grabber-rules-file) + +## Custom CSS +Sometimes you want to add additional CSS for a feed to improve the rendering. This can very easily be done by adding a CSS class to **css/custom.css** following the following naming convention: + +* Take the URL from the \<link> attribute (e.g.: \<link>https://www.google.de/path?my=query \</link>) +* Extract the Domain from the URL (e.g.: www.google.de) +* Strip the leading **www.** (e.g.: google.de) +* Replace all . with - (e.g.: google-de) +* Prepend **custom-** (e.g.: custom-google-de) + +Each class rule should be prefixed with **#app-content** and should only affect the article body. An example rule would be: + +```css +#app-content .custom-google-de .body { + /* Custom CSS rules here */ +} +```
\ No newline at end of file diff --git a/docs/developer/external-api-v2/README.md b/docs/developer/External-Api.md index 8d20bd794..8d20bd794 100644 --- a/docs/developer/external-api-v2/README.md +++ b/docs/developer/External-Api.md diff --git a/docs/developer/plugins/README.md b/docs/developer/Plugins.md index 22d29efa7..22d29efa7 100644 --- a/docs/developer/plugins/README.md +++ b/docs/developer/Plugins.md diff --git a/docs/developer/README.md b/docs/developer/README.md new file mode 100644 index 000000000..2ca0d2ac6 --- /dev/null +++ b/docs/developer/README.md @@ -0,0 +1,6 @@ +# Developer Documentation +As a developer you can interact with the News app in the following ways: + +* [External API](External-Api.md): API specification for syncing and updating feeds +* [Plugins](Plugins.md): How to write client and server-side plugins +* [Article enhancers](Article-Enhancers.md): Add custom CSS for a feed or add rules for full text feeds
\ No newline at end of file |