pulsar/docs
Corey Johnson ce881c87b9 Merge pull request #1486 from atom/cj-first-package-doc
Simplify first package docs
2014-01-28 13:51:16 -08:00
..
advanced Revise in-depth keymap overview 2014-01-25 17:49:40 -07:00
proposals Nuke private beta docs 2014-01-21 20:34:57 -07:00
building-atom.md Remove cmake dependency 2013-12-04 08:48:45 -08:00
creating-a-package.md Rename internals directory to advanced 2014-01-21 21:04:33 -07:00
creating-a-theme.md Update cmd-shift-P references and getting started doc 2013-12-04 14:07:43 -08:00
customizing-atom.md Remove unused core.hideGitIgnoredFiles config setting 2013-12-10 11:07:05 -08:00
getting-started.md Streamline the getting started docs 2014-01-21 20:33:53 -07:00
index.md Rename internals directory to advanced 2014-01-21 21:04:33 -07:00
README.md Doc available classes from 2014-01-23 15:13:12 -08:00
setting-up-travis.md 📝 Mention build-package script and atom-master-builds 2013-12-10 17:37:32 -08: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 Use json to render code block 2014-01-28 11:33:07 -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.