Skip to content
This repository has been archived by the owner on Feb 24, 2022. It is now read-only.

Latest commit

 

History

History
210 lines (135 loc) · 8.22 KB

README.md

File metadata and controls

210 lines (135 loc) · 8.22 KB
Raw

Logo

Not maintained anymore!


Reddit-Viewer

A Visual Studio Code extension to browse Reddit. Provides a code-styled webview and a tree-view widget.


  1. Features
    1. Widget
      1. Sort The Articles
      2. Open An Article
    2. Code Viewer
      1. Open A Subreddit
      2. Global Search
      3. Login
      4. Frontpage
      5. Browse Articles
      6. Browse Userpages
      7. Sort Articles And Comments
      8. Pagination
      9. Change The Code Style
  2. Requirements
  3. Documentation
  4. Extension Settings
  5. Known Issues
  6. Planned Features
  7. Release Notes

Features

Widget

The Reddit-Viewer widget enables an optional view to access the frontpage and your favorite subreddit fast and resource-friendly.

Sort The Articles

Sort the articles in the widget by the default sort-types. You can define the default sort in the configuration.

Open An Article

You can open the articles displayed in the widget in the code viewer or your default browser. The primary action can be defined in the configuration. The secondary action can be triggered in the context menu.

Code Viewer

The Reddit-Viewer code viewer is a webview which allows you to browse Reddit in code style. Even though it is a webview, it is pretty lightweight and simple.

Open A Subreddit

Open a subreddit and browse its articles. You can see a preview if the post contains a thumbnail.

Global Search

Search through subreddits and articles.

Login

Login with your account to show the frontpage with your subscribed subreddits.

Frontpage

Browse your own frontpage or a subreddit of your choice.

Browse Articles

Browse articles and show the selftexts or images.

Browse Userpages

Browse userpages and show the articles and comments of that user.

Sort Articles And Comments

You can sort articles and comments in every view with the default sort- and time-types.

Pagination

Browse through multiple pages.

Change The Code Style

Change between the available code styles.

Requirements

This extension requires Visual Studio Code 1.40.x or later and an active connection to the internet to work properly.

Documentation

The documentaion for this extension is available at Reddit-Viewer Doc.

Extension Settings

This extension contributes the following settings:

  • RedditViewer.Title: Controls the name of the webview panel.
  • RedditViewer.Style: Controls the style to be used for the code viewer.
  • RedditViewer.UserManagement: Enable/disable user management elements and requests.

  • RedditViewer.HomeTrending: Enable/disable the trending subreddits in the home view.
  • RedditViewer.HomeFrontpage: Enable/disable the article section in the home view.
  • RedditViewer.HomeFrontpageMine: Enable/disable the own frontpage in the article section of the home view.
  • RedditViewer.HomeFrontpageSubreddit: Controls the subreddit to be shown in the article section of the home view.
  • RedditViewer.HomeFrontpageLimit: Controls the number of articles to be loaded in the article section of the home view.
  • RedditViewer.HomeFrontpageTime: Controls the default time interval for the article section of the home view.
  • RedditViewer.HomeFrontpageSort: Controls the default sort type for the article section of the home view.

  • RedditViewer.SearchLimit: Controls the number of articles to be loaded in the search view.
  • RedditViewer.SearchTime: Controls the default time interval in the search view.
  • RedditViewer.SearchSort: Controls the default sort type in the search view.

  • RedditViewer.SubredditLimit: Controls the number of articles to be loaded in the subreddit view.
  • RedditViewer.SubredditTime: Controls the default time interval in the subreddit view.
  • RedditViewer.SubredditSort: Controls the default sort type in the subreddit view.

  • RedditViewer.ArticleCommentLimit: Controls the number of comments to be loaded in the article view.
  • RedditViewer.ArticleCommentDepth: Controls the depth of the comments to be loaded in the article view.
  • RedditViewer.ArticleCommentSort: Controls the default sort type in the subreddit view.

  • RedditViewer.UserLimit: Controls the number of articles and comments to be loaded in the user view.
  • RedditViewer.UserTime: Controls the default time interval in the user view.
  • RedditViewer.UserSort: Controls the default sort type in the subreddit view.

  • RedditViewerWidget.Frontpage: Enable/disable the frontpage provider in the widget.
  • RedditViewerWidget.FrontpageLimit: Controls the number of articles to be loaded in the frontpage provider of the widget.
  • RedditViewerWidget.FrontpageTime: Controls the default time interval in the frontpage provider of the widget.
  • RedditViewerWidget.FrontpageSort: Controls the default sort type in the fronpage provider of the widget.

  • RedditViewerWidget.Subreddit: Enable/disable the subreddit provider in the widget.
  • RedditViewerWidget.SubredditDefault: Controls the subreddit to be shown in the subreddit provider of the widget.
  • RedditViewerWidget.SubredditLimit: Controls the number of articles to be loaded in the subreddit provider of the widget.
  • RedditViewerWidget.SubredditTime: Controls the default time interval in the subreddit provider of the widget.
  • RedditViewerWidget.SubredditSort: Controls the default sort type in the subreddit provider of the widget.

  • RedditViewerWidget.OpenType: Controls the type to be used when opening an article in the widget.

Known Issues

Planned features

Contributing

Release Notes

For all releases take a look at the Changelog.

2.0.0

  • Migrated to TypeScript
  • Added text markdown (selftext, comments)
  • Better styling
  • Added different code styles (TypeScript, PHP)
  • Added widget