Code Monkey home page Code Monkey logo

tldr.jsx's Issues

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

Loading indicator

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

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.

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.