diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 16 |
1 files changed, 6 insertions, 10 deletions
diff --git a/docs/README.md b/docs/README.md index 62c2dac07..d9b331250 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,13 +1,9 @@ -# Documentation +# News Documentation +The News documentation of News uses mkdocs and is hosted [here](https://nextcloud.github.io/news/). +As extension of mkdocs, mkdocs-material is used. -As a developer you can interact with the News app in the following ways: - -* [Use the API for syncing and updating feeds](externalapi/) -* [Write plugins](plugins/) -* [Add custom CSS for feeds](feedcss/) -* [Customize the explore section](explore/) - - -The News app uses [FeedIO](https://github.com/alexdebril/feed-io) for parsing feeds and full text feeds. FeedIO is a fantastic library so if you contribute or fix bugs, please consider **contributing your changes** back to the library to help others :) +Check the resources below for how to install both of them locally. +* [mkdocs](https://www.mkdocs.org/) +* [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) |