🔣 Atom extension to search and view content from SyntaxDB.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
keymaps
lib
menus
screenshots
spec
styles
.gitignore
CHANGELOG.md
LICENSE
README.md
package.json

README.md

SyntaxDB Atom Plugin

Front

An atom package that provides a simple interface to search and view the SyntaxDB database.

Installation

Either clone this repo into your packages directory or download it from the atom packages repository.

How to Use

To use the atom package, make sure it's installed, then press Ctrl-Alt-S to activate the SyntaxDB search panel. To activate the language filter, which displays all concepts on the SyntaxDB database by language, press Ctrl-Alt-L.

Search View
SyntaxDB plugin search bar

On the search panel, type in a search query (eg. "for loop in Java") and press enter. A list view will then appear, displaying the results it has gathered from the SyntaxDB API. Selecting any of these results will bring up a results view for the entry, displaying its syntax as well as additional information.

Results View
Currently, the results view displays notes, syntax, example(s), and documentation about the specified syntax.

It is also possible to place the syntax example provided by SyntaxDB directly into your document. To do this, make sure the Example tab is currently selected, then press the "Place in Document" button. (or press shift-enter)

Placing Example into Document
Example of placing an example into a document.

Issues

Future Additions

  • Finish spec tests
  • Improve package activation time
  • Convert to CoffeeScript
  • Save common results to cache (via View serialization or some other method)