electron/docs
Alice Zhao 9056dd728a
feat: add `navigationHistory.getEntryAtIndex(int index)` method (#41662)
* feat: add `navigationHistory.getEntryAtIndex(int index)` method (#41577)

* test: fix flaky tests by replacing real urls with data urls

* test: remove hardcoded url
2024-04-05 13:59:46 -04:00
..
api feat: add `navigationHistory.getEntryAtIndex(int index)` method (#41662) 2024-04-05 13:59:46 -04:00
development docs: add reclient docs, remove goma docs (#40948) 2024-01-12 13:50:20 +13: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 (#41553) 2024-03-12 12:51:35 -04:00
tutorial build: add Markdown lint check for unescaped angle brackets (#41779) 2024-04-05 13:53:42 -04:00
README.md feat: replace BrowserView with WebContentsView (#35658) 2023-12-13 13:01:03 -08:00
breaking-changes.md docs: backslash escape parametrized TypeScript types (#41693) 2024-03-26 12:28:47 +01: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