Skip to content
This repository has been archived by the owner on Jun 20, 2021. It is now read-only.

leostera/tldr.jsx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Sep 28, 2020
d1efe52 Β· Sep 28, 2020
Sep 28, 2020
Jul 2, 2016
Jul 9, 2020
Jul 9, 2020
Aug 12, 2016
Jul 19, 2016
Jul 2, 2016
Jul 1, 2016
Aug 12, 2016
Aug 28, 2016
Oct 16, 2016
Aug 27, 2018
Jul 9, 2020
Jul 9, 2020
Jul 16, 2016
Jul 9, 2020
Jul 5, 2016
Jul 9, 2020

Repository files navigation

tldr.jsx Travis-CI

πŸ“š A Reactive web client for tldr-pages. Try it here.

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

Become a Patron

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