pulsar/docs
2014-04-01 10:27:35 -06:00
..
advanced Document unset! and native! directives in keymap system 2014-04-01 10:27:35 -06:00
contributing.md Update reference syntax in contributing docs 2014-02-20 16:34:53 -07:00
converting-a-text-mate-bundle.md 📝 publishing not publish in links 2014-02-27 12:07:13 -08:00
converting-a-text-mate-theme.md 📝 publishing not publish in links 2014-02-27 12:07:13 -08:00
creating-a-package.md 📝 Update styleguide keybinding 2014-03-11 12:29:23 -07:00
creating-a-theme.md Update docs on window:reloading 2014-03-24 09:38:40 -07:00
customizing-atom.md Remove defunct 'autoIndentOnPaste' option from customizing-atom docs 2014-03-07 13:39:36 -07:00
getting-started.md use cmd instead of meta in docs 2014-04-01 18:11:23 +02:00
index.md Link to proper theme doc 2014-02-27 08:00:43 -08:00
publishing-a-package.md Remove stray g 2014-02-13 15:37:10 -08:00
README.md Add Workspace to exported class list 2014-03-05 09:00:39 -07:00
template.jst copy docs into atom.io project, don't build guides as they are in the DB 2013-11-04 16:47:12 -08:00
theme-variables.md Address a few more typos 2013-10-30 15:21:51 -07:00
your-first-package.md Avoid using the atom- prefix 2014-03-06 08:50:18 -08:00

Welcome to the Atom API Documentation

Atom

FAQ

Where do I start?

Check out EditorView and Editor classes for a good overview of the main editor API.

How do I access these classes?

Check out the Atom class docs to see what globals are available and what they provide.

You can also require many of these classes in your package via:

{EditorView} = require 'atom'

The classes available from require 'atom' are:

How do I create a package?

You probably want to read the creating a package doc first and come back here when you are done.

Where are the node docs?

Atom ships with node 0.11.10 and the comprehensive node API docs are available here.