electron/docs
Mark Lee 2e6fff885d
docs: clean up protocol docs (#22262)
* docs: clean up protocol docs

* Fix capitalization
2020-02-20 11:27:17 -06:00
..
api docs: clean up protocol docs (#22262) 2020-02-20 11:27:17 -06:00
development docs: update dev docs atom -> shell (#22199) 2020-02-17 09:47:22 +09:00
fiddles docs: replace electron.atom.io with electronjs.org in docs/fiddles (#22196) 2020-02-17 09:46:41 +09:00
images docs: Explain notarization, improve code-signing docs (#21373) 2019-12-13 11:16:20 -05:00
tutorial docs: Correct Electron 9 stable date (#22258) 2020-02-19 18:10:19 -05:00
breaking-changes-ns.md docs: move breaking changes out of API folder (#21870) 2020-01-28 22:19:18 +00:00
breaking-changes.md feat: disable the remote module by default (#22091) 2020-02-10 10:49:09 -08:00
faq.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
glossary.md
README.md docs: document supported extensions apis (#22021) 2020-02-06 16:36:02 -05:00
styleguide.md docs: differentiate static/instance class props (#19196) 2019-07-15 10:15:32 -07:00

Official Guides

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:

Guides and Tutorials

Detailed Tutorials

These individual tutorials expand on topics discussed in the guide above.


API References

Custom DOM Elements:

Modules for the Main Process:

Modules for the Renderer Process (Web Page):

Modules for Both Processes:

Development

See development/README.md