mirror of
https://github.com/atom/atom.git
synced 2026-01-22 21:38:10 -05:00
1211680998
Both documents had some really great stuff to them, but there was too much overlap. I did my best to unify them into one document, taking the best features of each.
Welcome to the Atom API Documentation
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:
- BufferedProcess
- BufferedNodeProcess
- EditorView
- Git
- Point
- Range
- ScrollView
- SelectListView
- View
- WorkspaceView
- Workspace
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.