📚 A Reactive web client for tldr-pages
JavaScript CSS HTML Makefile Shell Vim script
Switch branches/tags
Clone or download

README.md

tldr.jsx Travis-CI

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

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!

tldr.ostera.io on desktop and mobile views

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 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.