electron/docs
trop[bot] 53d7bd6abd
chore: emphasize documentation style guide (#45909)
docs: emphasize documentation style guide

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Erick Zhao <ezhao@slack-corp.com>
2025-03-06 16:13:49 -05:00
..
api feat: support global shortcuts via GlobalShortcutsPortal feature with ozone/wayland (#45297) 2025-02-27 11:33:12 +01:00
development chore: emphasize documentation style guide (#45909) 2025-03-06 16:13:49 -05:00
fiddles docs: remove extra " (#45029) 2024-12-16 13:20:17 -05:00
images docs: add custom titlebar example (#43693) 2024-11-01 11:04:37 -04:00
tutorial docs: update timelines for E36 (#45849) 2025-02-28 12:24:03 +01:00
api-history.schema.json docs: api history (#42982) 2024-08-19 11:17:10 -07:00
breaking-changes.md docs: update breaking-changes.md for 35.0.0 (#45847) 2025-02-28 11:24:09 +01:00
experimental.md docs: fix apostrophe typo "Electrons" -> "Electron's" (#44516) 2024-11-02 15:52:22 -05:00
faq.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
glossary.md docs: update docs.microsoft.com links to learn.microsoft.com (#37707) 2023-03-29 12:16:44 +02:00
README.md feat: ServiceWorkerMain (#45341) 2025-01-31 12:40:19 -05:00
why-electron.md docs: Why Electron? (#45191) (#45222) 2025-01-16 14:06:57 -05: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