electron

History

Cameron Nokes 3239da37dd Fix docs: app.md `setLoginItemSettings` `app.setLoginItemSettings` documented arguments are misleading -- `path` and `args` should be passed in the `settings` object, not as separate params, like the code sample below it or in the test file here: `9250b559f9/spec/api-app-spec.js (L336)` and in the actual C++ function declaration here: `f5a75c4e87/atom/browser/browser.h (L104)`		2017-06-21 16:24:00 -06:00
..
api	Fix docs: app.md `setLoginItemSettings`	2017-06-21 16:24:00 -06:00
development	fix typo in linux build instructions	2017-06-19 08:45:06 -07:00
tutorial	Remove `bash` from windows commands to prevent syntax highlighting errors (#1 )	2017-06-20 15:25:42 +01:00
faq.md	Update faq.md	2017-04-22 23:11:04 -04:00
glossary.md	Change NSIS topic level from 2 to 3	2017-06-16 14:45:49 -03:00
README.md	Add BrowserView to docs index	2017-05-22 17:12:17 +03:00
styleguide.md	Put optional label before dash	2016-12-29 14:11:26 -08:00

README.md

Please make sure that you use the documents that match your Electron version. The version number should be a part of the page URL. If it's not, you are probably using the documentation of a development branch which may contain API changes that are not compatible with your Electron version. To view older versions of the documentation, you can browse by tag on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag that matches your version.

FAQ

There are questions that are asked quite often. Check this out before creating an issue:

README.md

FAQ

Guides

Tutorials

API References

Custom DOM Elements:

Modules for the Main Process:

Modules for the Renderer Process (Web Page):

Modules for Both Processes:

Development