pulsar/docs
Ben Ogle 22c4992788 Merge pull request #2760 from atom/package-api-stability-notice
Add stability message for Atom.io API
2014-07-11 10:58:57 -07:00
..
advanced 📝 Remove observeConfig 2014-06-25 08:11:30 -07:00
build-instructions 📝 Wrap line and use single backticks 2014-06-23 09:36:44 -07:00
apm-rest-api.md Merge pull request #2760 from atom/package-api-stability-notice 2014-07-11 10:58:57 -07:00
contributing-to-packages.md Split out the package-specific information 2014-05-21 11:35:23 -07:00
contributing.md 📝 Unify the two contributing documents 2014-05-20 10:35:18 -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 context menu doc 2014-06-03 10:25:12 -07:00
creating-a-theme.md Update docs on window:reloading 2014-03-24 09:38:40 -07:00
customizing-atom.md 📝 Add is-focused class to cursor example 2014-07-06 10:08:24 -07:00
debugging.md Add overview to debugging guide 2014-06-15 13:27:04 +02:00
getting-started.md use cmd instead of meta in docs 2014-04-01 18:11:23 +02:00
index.md Add debugging guide to list of guides 2014-06-07 11:45:25 +02:00
publishing-a-package.md ⓒⓛⓐⓡⓘⓕⓘⓒⓐⓣⓘⓞⓝ 2014-05-23 19:12:12 -04: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
writing-specs.md Remove runs description 2014-07-01 14:26:44 -07:00
your-first-package.md Add links to writing specs doc 2014-05-21 14:47:30 -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.