leostera / tldr.jsx

📚 A Reactive web client for tldr-pages

tldr.jsx

📚 A Reactive web client for tldr-pages. Try it here.

If you've found this project useful, you can now support me on Patreon

Featuring

• Unique URIs, to easily share any tldr-page!
• Mobile-first-ish, to take with you anywhere!
• Fully Reactive, embracing ES6, RxJS, FlowType and React for great win!

Roadmap

As tldr-pages advances, new features can be planned. Some are:

• Autocompletion, freeing you from remembering all those command names
• Search, letting you search through all the pages and commands content to find what you want

See the issues page for a list of planned enhancements and features.

Collaboration Setup

It requires a working node environment with npm, and make.

• make to prepare the workspace and do the first build from scratch
• make build, for a development build
• make test, to run the test suite
• make lint, to lint the source
• make check, to type-check everything
• make package, to create a distributable package

Serve locally as you wish, I prefer static-server.

But what about Y or X and File Watchers!

File Watchers never really manage to work the way you want them to, so I ended up using ostera/watch for auto-building, auto-testing, auto-anything.

License

See LICENSE.

tldr.jsx's Issues

Provide autocompletion when typing on search bar

Cache dependencies on Travis

Just that: https://docs.travis-ci.com/user/caching/

Suggest edition of page and direct link to Github .md file

E.g. "edit this page" or "see on github".

Support external lookups for tldr.md page in github repos

Use-case:

I have watch and try. Two small cli utils that have no place in tldr itself because they do not come bundled with any UN*X distro.

I'd like to be able to reuse the current frontend and serve a small tldr page on how to use it from within the repo, by requesting https://tldr.ostera.io/ostera/watch.

The page could live in ./TLDR.md inside the ostera/watch repo.

Upsides:

• Effectively allow any repo out there to use tldr.jsx without polluting the index into gigantic proportions
• Drive more traffic that will drive our improvements to the tldr-pages

Downsides:

• Not being able to suggest ostera/try as an alternative to a failed command search for try
• Unclear how to lint these external pages, non-vetted content could be an issue

I'd like to know what @waldyrious thinks of this.

Hookup Mixpanel Tracking

As per discussion on: tldr-pages/tldr#948

OpenSearch Description

How about adding a OpenSearch Description Document.
Basically just a xml file telling the browser how to search in the tldr pages.
So I could enter the url of the webpage in chromium press tab write "git tag" press enter and I would be on the according tldr-page.
Further information: http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_description_document0

Not clear enough that a new page is rendered

Make it evident that a new page has been rendered, some pages have so similar a format that it makes it hard to see if there was any change at all.

Unigrid

Make small sass mixin for grid's based on http://uniweb.victorfleur.com/uniweb.css

.content
  +grid(columns: 2, rows: 2)

Tap to Copy for code blocks on mobile

Update README

Needs new pictures

if platform is specified, skip index and try to fetch the file directly

Link for editing remains after you change the command

Steps to reproduce:

1. Open the page
2. Insert "ln".
3. Wait for page to load, notice the link to edit ln.md page.
4. Press "BackSpace" in the search field.
5. The page is updated to "No such command", but the link to edit ln.md remains.

https://monosnap.com/file/0atBOhRWgXGHY6n6oRKP41iQwuBRdw

Serve over HTTPS

Github now makes this easy with a simple configuration toggle (IIUC): https://github.com/blog/2186-https-for-github-pages

This is required for proper embedding on tldr-pages.github.io

Command Suggestion

If command is not found, offer a suggestion based on the input string Levenshtein distance to the indexed commands.

If command is found for another platform, show it under the suggestions as well.

Implement search subcommand

Media queries messing up content on Tablet sized screens

Cache (all) pages locally

Add night-mode by applying a top-level class that redefines the color palette

Make inline code tags not full-width

Import are getting ../../-ish, let's symlink the source folder to node_modules/tldr

Navbar styling is broken in tldr-pages.github.io iframe due to size

Add suggestion to download native client based on operating system

Look up OPTIONS request returning 405 on Github (ask support?)

[Race condition] Command look up occurs before index load

yield on index loading, then do the look up

Add support for routes

Wouldn't it be nice to be able to share this pages easily? www.ostera.io/tldr.jsx/git-add, as per tldr-pages/tldr#440.

Move to ES6 RxJS

http://www.ostera.io/tldr.jsx/ Broken

http://www.ostera.io/tldr.jsx/ should probably redirect to the new? site: https://tldr.ostera.io/

Backquotes in example description forcing new line

Hi,

On pages like history, the example markdown contains embedded backquotes (surrounding bash):

- Clear the commands history list (only for `bash`)

The client reads it as a command inserts a new line before and after.

The output looks something like :

Clear the commands history list (only for
bash
)

Cordially

Parameterize repository URI

It'll make it possible to point to other repositories (forks) and maybe even bropages.

Setup test harness for logic and presentation

Investigate using a web worker to fetch pages in the background

Only lowercase commands are found

• Lowercase everything before searching.

Replace spaces with dashes and lowercase everything on the search bar

Cache the index using localStorage

Add version

Type All Things!

Implement cache breaking by revision-tagging artifacts

Make Link not reload page

Fix search field looking on Safari

Allow spaces in search field

Fix space between navbar and content when scroll=0

Design a responsive layout

Make it look sweet on mobile!

Add support to specify a branch

Loading indicator

A spinner animation or "loading..." text would be nice to provide an indication that the page is fetching the requested command.

Center design on page

Failed to parse SourceMap: https://tldr.ostera.io/undefined.map

Add github buttons

Take a look here: https://buttons.github.io/

Switch from fetching assets to querying the Github API with "If-Modified-Since"

Setup Travis-CI S3 Deployment

• Build dist target
• Use deploy: config to deploy assets to S3
• With an after_deploy: script invalidate the index.html from CloudFront (more info on keys)

Maybe:

• Investigate other invalidation mechanisms for index.html file

Unobtrusive debug box

Fix to the right, with a smaller size