pulsar/docs
Kevin Sawicki 6cae6981d8 Recommend cloning to shallow path
Prevents path length issues
2014-05-16 13:29:39 -07:00
..
advanced 📝 Document process for hacking node module components 2014-05-14 18:25:12 -07:00
build-instructions Recommend cloning to shallow path 2014-05-16 13:29:39 -07:00
contributing.md Update reference syntax in contributing docs 2014-02-20 16:34:53 -07:00
converting-a-text-mate-bundle.md Fix link for TextMate's GitHub Organization 2014-05-12 15:56:06 -03:00
converting-a-text-mate-theme.md Fixed typos 2014-05-07 08:52:58 +01: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 Fixed typos 2014-05-07 08:52:58 +01:00
getting-started.md use cmd instead of meta in docs 2014-04-01 18:11:23 +02:00
index.md 📝 Document process for hacking node module components 2014-05-14 18:25:12 -07:00
publishing-a-package.md Fixed typos 2014-05-07 08:52:58 +01:00
README.md Logo in the docs 2014-05-04 15:48:25 -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 Update broken link to publish doc 2014-04-24 13:56:14 -07: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.