Skip to content

anko/wat

 
 

Repository files navigation

Wat

Build Status Build Status Build Status

Mad Science meets Real World Practicality meets Documentation. Wat.

Finally, community-built cheat sheets for every coder, targeting any framework, in any language. At the tip of your fingers.

Wat is an interactive app built to drastically reduce time spent searching for syntax and code usage questions. Wat aggregates project APIs, readmes, code snippits, usage samples and practical documentation across any language or libary, and makes this data ridiculously accessible from a single, instant source.

Wat was designed for ease. It takes you:

Contents

Made with ❤️ and a little secret sauce.

Introduction

Wat is nearing its launch, and you can help

Feel free to install and try Wat out. Wanted are suggestions on how to make Wat even more ridiculously easy to use and insanely helpful. All document contributions are welcome as well!

1.0 targets:

To do
  • Manual-generated libraries completed: JS, HTML, CSS, Node
  • Automatic doc scaffolding
  • Auto-doc config and refactor.
  • Finish Github and Stack Overflow web searches.
  • Spiffy GIF
  • Tour
  • Finish Tests.
  • Suggestions? Wat is for you, and must be uncomprimisingly amazing.
Done
  • XO linting.
  • Search commands implemented.
  • Preference commands implemented (syntax highlighting flavor, etc.).
  • Finish readme / editing guidelines.
  • Refactor Vorpal dependency to Vantage.
  • Change temp directory for all persistent local storage and configurations.
  • Babel transpiling.
  • Pass args into initial app call (i.e. make $ wat js array splice start up the application and return the results.)
  • Graceful exiting with CONTROL + C.

Wat covers everything

Wat provides the only centralized source of syntax cheat sheets for every language and every major framework and library. If it has an API and is used by the community, it's supported here; be it jQuery, Go, React, Dragula or Rails.

It's smart

Wat combines a document index, edit-distance algorithms, tabbed auto-completion and common sense to make sure you get what you asked for. It auto-updates when the community adds content, and optimizes its performance based on the content you use most.

Wat shreds red tape like a frisky cat

Wat's content is not perfect, it isn't formal and it isn't pedantic. Wat doesn't aim to provide letter-perfect, offical documentation for languages. Work like that is in good hands.

If you're building a web browser, refer to W3C for specifications. Wat is targeted for the 99.99% of us who have the basic familiarity with a Library and simply need to look up API or usage samples.

Install

npm install -g wat

np-what? Oh, isn't that Node? I don't do Node.

Learn

wat tour

Contribute

Help the community and submit a pull request within 15 minutes.

If you understand Markdown and are familiar with a language or library, you can contribute!

  1. Pick your favorite library.

  2. Read the editing guidelines.

  3. Read the contribution guidelines.

  4. Start!

Love Wat? Help spread the word. Every contribution helps the community even more.

Projects now documented on Wat

Languages

JS

Node.js Frameworks

Chalk, RobotJS, Vantage, Vorpal

FAQ

Why Wat?

Because wat is forgetting the syntax to splice an Array for the 10th time.

Because wat is having to search js splice an array, sift through W3Schools and MSDN results, Command + Click three Stack Overflow tabs, close the first one, digest the second and then scroll to the answer to remember... again.

Because I would rather just type:

wat js array splice

Sorry, I don't speak Node

Don't worry, it's not a problem:

You're using a web browser, right? Web browsers interpret Javascript on the Internet.

Similarly, Node interprets Javascript everywhere else. You don't have to write JS to use Node.

Installation is easy and you won't regret it: there's hundreds of incredible apps you'll be able to take advantage of.

Node installation links:

Once installed, open a terminal and type:

npm install --global wat

This automatically installs it and makes the command wat recognized globally by your computer, so you just run wat in your terminal.

Easy, right? And you're still a proud [insert language here...] developer.

You're ready to use it!

How does Wat relate to Dash?

Dash is extraordinarily well put together API Documentation Browser and Code Snippet Manager for OSX and iOS. It stores snippets of code and instantly searches offline documentation sets for 150+ APIs.

Dash is a desktop application, and is more focused on centralizing official docs in addition to its cheat sheets. Wat is a command-line-based application and is more targeted at centralizing smaller libraries across all languages.

Whichever your preference, Dash and Wat intend to work together to cover all bases with the common purpose of giving you fast-as-possible reference to the code you use.

License

MIT

About

A unique end to syntax hell

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%