hill/tldr-chrome

Simplified and community-driven man pages for chrome!

This repo is not maintained.

Please use this fork by @piraces instead. Thanks :)

tldr-chrome

📚 A chrome extension for tldr-pages.

🚧 The Roadmap

(feel free to contribute 😄)

Download

Get the extension here

Loading Extension

• The extension is yet to be released to the chrome webstore.
• To load the extension, download the repository and open extension preferences in chrome (go to chrome://extensions). Click the box marked developer mode and click the button load unpacked extension... after which you can navigate to the project directory and load tldr chrome
• Ensure you compile styles/main.scss to styles/main.css

How it works

• Highlight and right click a command on your webpage and select tldr in the drop down - a tooltip should appear with information fetched from tldr-pages

tldr-chrome's Issues

Implement Fetch over XMLHttpRequest

@agnivade suggested converting to fetch() over at the main tldr repo here

His comments were:

It is essentially a big improvement over XMLHttpRequest. Any modern codebase should use fetch instead of XMLHttpRequest.
MDN - https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
Here it is in devdocs - http://devdocs.io/dom/fetch_api/using_fetch

Refactor to a consistent syntax

A couple of things for this, but mainly picking which type of JavaScript syntax to use.

I noticed that there is a use of let at the top, which is ES2015 and then var throughout the script, which is standard JavaScript.

Which syntax would you prefer to use?

This extension is aging - anyone want to keep this cool extension updated?

Anyone want to keep this app's tl;dr reference file(s) updated with the latest pages available at the master repo?

The master repo (I believe) is located here: https://github.com/tldr-pages/tldr/tree/master/pages

External stylesheet with unique id

In Chrome extensions, you can specify a stylesheet which I think may be a better way of managing the files. (see content_scripts)

In v0.2.0 it mentions to remove inherited styles from the document, it may be worth applying a unique id to the main popup (as you will only have 1 at a time) such as #tldr-chrome-popup, and then apply the styles under this.

I've tested this locally and it seems to work fine. It would also mean that the styles wouldn't be applied dynamically as in main.js#L8 and throughout main.js.

This app 's tl;dr info is out-of-date from the master repo at https://github.com/tldr-pages/tldr-pages.github.io

@pxgamer

This app is out -of-date from the master repo at https://github.com/tldr-pages/tldr/tree/master/pages

Please update your app to include the latest info, or better yet build a curl / wget / git script to pull in the changes to the master repo from time-to-time

Please see tickethttps://github.com/tldr-pages/tldr-pages.github.io/issues/37 for reference

Ensure tooltip does not disappear when clicking inside the tooltip

Ensure tooltip does not disappear when clicking inside the tooltip.

It prevents allowing copy/paste of the commands as well as clicking the link in the not found page.