Mailspring/packages/client-app/docs_src/README.md

## Nylas Mail Plugin SDK

<center>
<img src="/img/nylas-sdk-cuub@2x.png" width=200/>
</center>

The Nylas SDK allows you to create powerful extensions to Nylas Mail, a mail client for Mac OS X, Windows, and Linux. Building on Nylas Mail saves time and allows you to build innovative new experiences fast.
[Get Started](https://nylas.github.io/nylas-mail/guides/GettingStarted.html)


#### Installing Nylas Mail

Nylas Mail is available for Mac, Windows, and Linux. Download the latest build for your platform below:

*   [Mac OS X](https://edgehill.nylas.com/download?platform=darwin)
*   [Linux](https://edgehill.nylas.com/download?platform=linux)
*   [Windows](https://edgehill.nylas.com/download?platform=win32)


#### Package Architecture

Packages lie at the heart of Nylas Mail. Each part of the core experience is a separate package that uses the Nylas Package API to add functionality to the client. Learn more about packages and create your first package.

*   [Create a Plugin](GettingStarted.md)
*   [Plugin Overview](PackageOverview.html)


#### Dive Deeper

*   [Application Architecture](http://nylas.github.io/nylas-mail/docs/Architecture.html)
*   [React & Component Injection](http://nylas.github.io/nylas-mail/docs/React.html)
*   [Core Interface Concepts](http://nylas.github.io/nylas-mail/docs/InterfaceConcepts.html)
*   [Accessing the Database](http://nylas.github.io/nylas-mail/docs/Database.html)
*   [Draft Store Extensions](http://nylas.github.io/nylas-mail/docs/DraftStoreExtension.html)


#### Debugging Packages

Nylas Mail is built on top of Electron, which runs the latest version of Chromium. Learn how to access debug tools in Electron and use our Developer Tools Extensions:

*   [Debugging in Nylas](http://nylas.github.io/nylas-mail/docs/Debugging.html)

#### Questions?

Need help? Check out the [FAQ](https://support.nylas.com/hc/en-us) or post a question in the [slack channel](http://slack-invite.nylas.com/).


#### TODOs

- Add plugin examples with code (es6 not coffeescript)
- Smart Linkify references. Maybe use something like [gitbook-plugin-regexplace](https://github.com/markomanninen/gitbook-plugin-regexplace)
- Have class reference files link to their actual sourcefiles
- Consider adding infinite scroll
Update documentation with GitBook 2017-01-28 03:42:53 +08:00			`## Nylas Mail Plugin SDK`

			`<center>`
			`<img src="/img/nylas-sdk-cuub@2x.png" width=200/>`
			`</center>`

			`The Nylas SDK allows you to create powerful extensions to Nylas Mail, a mail client for Mac OS X, Windows, and Linux. Building on Nylas Mail saves time and allows you to build innovative new experiences fast.`
Fix broken link (#3284) 2017-02-14 13:53:57 +08:00			`[Get Started](https://nylas.github.io/nylas-mail/guides/GettingStarted.html)`
Update documentation with GitBook 2017-01-28 03:42:53 +08:00

			`#### Installing Nylas Mail`

			`Nylas Mail is available for Mac, Windows, and Linux. Download the latest build for your platform below:`

			`* [Mac OS X](https://edgehill.nylas.com/download?platform=darwin)`
			`* [Linux](https://edgehill.nylas.com/download?platform=linux)`
			`* [Windows](https://edgehill.nylas.com/download?platform=win32)`


			`#### Package Architecture`

			`Packages lie at the heart of Nylas Mail. Each part of the core experience is a separate package that uses the Nylas Package API to add functionality to the client. Learn more about packages and create your first package.`

			`* [Create a Plugin](GettingStarted.md)`
			`* [Plugin Overview](PackageOverview.html)`


			`#### Dive Deeper`

			`* [Application Architecture](http://nylas.github.io/nylas-mail/docs/Architecture.html)`
			`* [React & Component Injection](http://nylas.github.io/nylas-mail/docs/React.html)`
			`* [Core Interface Concepts](http://nylas.github.io/nylas-mail/docs/InterfaceConcepts.html)`
			`* [Accessing the Database](http://nylas.github.io/nylas-mail/docs/Database.html)`
			`* [Draft Store Extensions](http://nylas.github.io/nylas-mail/docs/DraftStoreExtension.html)`


			`#### Debugging Packages`

			`Nylas Mail is built on top of Electron, which runs the latest version of Chromium. Learn how to access debug tools in Electron and use our Developer Tools Extensions:`

			`* [Debugging in Nylas](http://nylas.github.io/nylas-mail/docs/Debugging.html)`

			`#### Questions?`

			`Need help? Check out the [FAQ](https://support.nylas.com/hc/en-us) or post a question in the [slack channel](http://slack-invite.nylas.com/).`


Update docs config - Don't ignore built class docs - pin requirement versions for docs - update docs build instructions - update repo URL 2017-01-31 04:02:27 +08:00			`#### TODOs`
Update documentation with GitBook 2017-01-28 03:42:53 +08:00
Update docs config - Don't ignore built class docs - pin requirement versions for docs - update docs build instructions - update repo URL 2017-01-31 04:02:27 +08:00			`- Add plugin examples with code (es6 not coffeescript)`
			`- Smart Linkify references. Maybe use something like [gitbook-plugin-regexplace](https://github.com/markomanninen/gitbook-plugin-regexplace)`
			`- Have class reference files link to their actual sourcefiles`
			`- Consider adding infinite scroll`
Update documentation with GitBook 2017-01-28 03:42:53 +08:00