electron/docs
2022-01-13 10:30:15 +09:00
..
api docs: explicitly allow string for MessageBoxOptions.icon (#32422) 2022-01-13 10:30:15 +09:00
development docs: fix wording on testing documentation (#32279) 2022-01-06 09:24:52 +09:00
fiddles docs: add window customization guide (#31054) 2021-10-19 09:58:35 +09:00
images fix: link to image (#31454) 2021-10-19 17:43:10 +09:00
tutorial [fix] Docs rendering issue with rendering on electronjs quick-start (#32293) 2022-01-03 11:18:02 -08:00
breaking-changes.md feat: remove nativeWindowOpen option (#29405) 2022-01-06 09:28:03 -08:00
experimental.md docs: document what experimental means explicitly (#22893) 2020-04-02 09:32:18 -07:00
faq.md docs: tidy up links (#26292) 2020-11-02 18:58:14 +09:00
glossary.md docs: update glossary (#30874) 2021-09-22 08:52:24 +09:00
README.md feat: remove nativeWindowOpen option (#29405) 2022-01-06 09:28:03 -08:00
styleguide.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06: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

Getting started

Learning the basics

Advanced steps

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