electron/docs
Samuel Attard 5bdaa42b01
build: update some build dependencies (#44071)
* build: update some build dependencies (#43882)

* build: update some build dependencies

* build: fix eslint issues after updating

* build: disable ts check on busted js example

* build: update internal types for stricter event handling

* restore url.parse behavior

* fix typing issues

* sigh

* build: update easy deps

* build: skip woa engines check

* build: s/colors/chalk

* build: node 20 on windows
2024-10-01 13:14:08 -07:00
..
api build: update some build dependencies (#44071) 2024-10-01 13:14:08 -07:00
development build: remove CircleCI (#42844) (#42909) 2024-07-15 16:00:20 -07:00
fiddles fix: incorrectly mapped toggleDevTools in custom menu fiddle (#40703) 2023-12-12 11:36:34 -08:00
images docs: Update code signing documentation (#41535) 2024-03-08 10:02:39 -08:00
tutorial docs: update window customization tutorial (#43661) 2024-09-10 10:12:11 +02:00
README.md feat: replace BrowserView with WebContentsView (#35658) 2023-12-13 13:01:03 -08:00
breaking-changes.md docs: ensure all links are on a single line (#42298) 2024-05-29 11:41:15 +02:00
experimental.md docs: Markdown linting and typo (#35568) 2022-09-13 13:49:11 -07: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
styleguide.md chore: disallow shortcut reference links in docs Markdown (#36860) 2023-01-16 10:22:49 +01:00

README.md

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