electron/docs
Samuel Attard 3879e9e065
build: remove the vendor directory (#28883)
The `vendor` directory is a remnant of times long since gone when we had
brightray and libchromiumcontent (never forget).  It is currently the
hope to a single header file that afaics we do not need anymore and
randomly pyyaml gets cloned there but that is easily movable.

This commit removes all references to the vendor directory from scripts,
docs, helpers, etc. and removes the directory itself.
2021-04-28 00:38:08 -07:00
..
api feat: add session.storagePath to get path on disk for session data (#28665) 2021-04-27 09:54:28 -07:00
development build: remove the vendor directory (#28883) 2021-04-28 00:38:08 -07:00
fiddles docs: update Quick Start Guide for Electron 12 (#28223) 2021-03-16 19:45:38 -04:00
images docs: revised dark mode feature page (#26187) 2020-11-02 16:18:29 +09:00
tutorial build: remove the vendor directory (#28883) 2021-04-28 00:38:08 -07:00
breaking-changes.md chore: remove app.allowRendererProcessReuse (#26874) 2021-04-21 13:59:11 -07: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: tidy up links (#26292) 2020-11-02 18:58:14 +09:00
README.md doc: desktopCapturer menu position (#28315) 2021-03-24 10:10:12 +09:00
styleguide.md docs: use asterisks for unordered lists (#26552) 2020-11-23 12:15:27 -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

Quickstart

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