Commit Graph

898 Commits

Author SHA1 Message Date
trop[bot]
5e1ccfa39a docs: fix link to docs/fiddle/quick-start (#29350)
Co-authored-by: Erick Zhao <erick@hotmail.ca>
2021-05-27 12:39:34 -07:00
trop[bot]
c4b04c5d08 docs: rework introduction docs (#29300)
* docs: add 'introduction' doc

* note

* wip

* updates

* wip

* wip

* wip

* add missing code

* wip

* add image for chrome processes

* process model wip

* finish line?

* update links

* Update docs/README.md

Co-authored-by: Cheng Zhao <github@zcbenz.com>

* Update docs/tutorial/introduction.md

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

* Update docs/tutorial/quick-start.md

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

* Update docs/tutorial/process-model.md

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

* Update docs/tutorial/process-model.md

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

* Update docs/tutorial/process-model.md

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

* Update docs/tutorial/quick-start.md

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

* Update docs/tutorial/quick-start.md

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

* Update docs/tutorial/quick-start.md

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

* Update docs/tutorial/quick-start.md

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

* address code review

* Update docs/tutorial/application-distribution.md

Co-authored-by: Mark Lee <malept@users.noreply.github.com>

* remove wip doc

* chore: fix lint error

Co-authored-by: Erick Zhao <erick@hotmail.ca>
Co-authored-by: Cheng Zhao <github@zcbenz.com>
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
Co-authored-by: Cheng Zhao <zcbenz@gmail.com>
2021-05-24 20:29:45 +09:00
trop[bot]
a22bcb51b3 docs: Update online detection doc and fiddle (#29308)
* rework online detection doc and fiddle

* add footnote

* Update docs/tutorial/online-offline-events.md

Co-authored-by: Erick Zhao <erick@hotmail.ca>

* Update docs/tutorial/online-offline-events.md

Co-authored-by: Erick Zhao <erick@hotmail.ca>

* Update docs/tutorial/online-offline-events.md

* Update docs/tutorial/online-offline-events.md

* Update docs/tutorial/online-offline-events.md

* chore: fix lint error

Co-authored-by: Ethan Arrowood <ethan.arrowood@gmail.com>
Co-authored-by: Ethan Arrowood <ethan@arrowood.dev>
Co-authored-by: Erick Zhao <erick@hotmail.ca>
Co-authored-by: Cheng Zhao <github@zcbenz.com>
2021-05-24 20:29:07 +09:00
trop[bot]
f3a26f6911 Use path.join when logging screenshot path. (#29304)
Remove index.html from offscreen-rendering tutorial.
It is not used.

Update offscreen-rendering.md to reflect changes to fiddle.

Co-authored-by: Kevin Hartman <kevin@hart.mn>
2021-05-24 16:47:35 +09:00
trop[bot]
a4cc2af8f4 docs: Update docs for keyboard shortcuts (#29302)
* Update docs for keyboard shortcuts

* Add a fiddle for web-apis

* Apply suggestions from code review

Co-authored-by: Erick Zhao <erick@hotmail.ca>

* Cleanup a few formatting errors and missed copies

* Add descriptions to index.html

* Focus on renderer

Co-authored-by: Tony Ferrell <anf@microsoft.com>
Co-authored-by: Tony Ferrell <tonyjf@gmail.com>
Co-authored-by: Erick Zhao <erick@hotmail.ca>
2021-05-24 16:36:07 +09:00
trop[bot]
419b675827 docs: Update the macos Dock Instructions (#29221)
* Update the macos Dock Instructions

* Remove preload and ;'s

* Mixed ;s

* Update dock doc

* Add informational text to index.html

Co-authored-by: Tony Ferrell <anf@microsoft.com>
2021-05-19 11:54:29 +09:00
trop[bot]
fe120bcd8d docs: Update macos-dark-mode fiddle and guide content (#29218)
* update macos dark mode docs for Electron v12

* pr review fixes

* more pr review fixes

* reorg paragraphs for better flow

* Update docs/tutorial/dark-mode.md

Co-authored-by: Erick Zhao <erick@hotmail.ca>

* pr fixes

Co-authored-by: Ethan Arrowood <ethan.arrowood@gmail.com>
Co-authored-by: Ethan Arrowood <ethan@arrowood.dev>
Co-authored-by: Erick Zhao <erick@hotmail.ca>
2021-05-19 11:53:44 +09:00
trop[bot]
8a0f89cfae docs: update drag and drop tutorial (#29217)
* Working

* Working

* Make the native-file drag and drop documents use context bridge

* Add per-file sections

* Use the updated link format

* Use path.join instead of string interpolation.

Co-authored-by: Antón Molleda <molant@users.noreply.github.com>

* Use fs.promises

Co-authored-by: Antón Molleda <molant@users.noreply.github.com>

* Update docs/tutorial/native-file-drag-drop.md

Co-authored-by: Antón Molleda <molant@users.noreply.github.com>

* fix formatting

Co-authored-by: Antón Molleda <molant@users.noreply.github.com>

* Update docs/tutorial/native-file-drag-drop.md

Co-authored-by: Antón Molleda <molant@users.noreply.github.com>

* Use more path.join instead of interpolation

* Update with PR suggestions

* Remove process.cwd() and add more example elements

* Minor text fix

* Fix typo

Co-authored-by: Erick Zhao <erick@hotmail.ca>

Co-authored-by: Tony Ferrell <anf@microsoft.com>
Co-authored-by: Tony Ferrell <tonyjf@gmail.com>
Co-authored-by: Antón Molleda <molant@users.noreply.github.com>
Co-authored-by: Erick Zhao <erick@hotmail.ca>
2021-05-19 11:53:20 +09:00
trop[bot]
f537755314 docs: revise Mac App Store Submission Guide (#29141) 2021-05-13 10:47:16 +02:00
Erick Zhao
7eceb43859 docs: rework sandbox guide (#29103)
Co-authored-by: Samuel Attard <samuel.r.attard@gmail.com>
Co-authored-by: Biru Mohanathas <birunthan@mohanathas.com>
Co-authored-by: Jeremy Rose <nornagon@nornagon.net>

Co-authored-by: Samuel Attard <samuel.r.attard@gmail.com>
Co-authored-by: Biru Mohanathas <birunthan@mohanathas.com>
Co-authored-by: Jeremy Rose <nornagon@nornagon.net>
2021-05-13 11:08:37 +09:00
trop[bot]
c5426713af docs: menu must be added on whenReady (#29042)
* Add that that menu must be added on whenReady

When an application menu is added before 'whenReady' all items seem to work except 'recent documents'

This causes the issue listed here: https://github.com/electron/electron/issues/17388

* Make example more complete

* Remove semicolons

* Update docs/tutorial/recent-documents.md

Co-authored-by: Erick Zhao <erick@hotmail.ca>

Co-authored-by: Matthijs Groen <matthijs.groen@gmail.com>
Co-authored-by: Erick Zhao <erick@hotmail.ca>
2021-05-06 20:23:35 +09:00
trop[bot]
9ae1cbebe0 docs: update REPL guide (#28985) 2021-05-04 11:51:16 +02:00
trop[bot]
1b9220525f docs: remove reference to global Electron install (#28968)
* docs: remove reference to global Electron install

This is a pattern that we actively want to discourage.

* docs: update as per review suggestion

Co-authored-by: Erick Zhao <erick@hotmail.ca>
2021-05-03 11:39:24 -04:00
trop[bot]
93c6c8c103 docs: define the name of the preload script (#28610)
Co-authored-by: KSneijders <32707500+KSneijders@users.noreply.github.com>
2021-04-12 00:13:53 -07:00
trop[bot]
facc12eafa docs: the minimum supported version of macOS is now 10.11 (#28515)
* chore: the minimum supported version is now 10.11

Chromium bumped this version back in December

* Update support.md

Co-authored-by: Samuel Attard <sam@electronjs.org>
2021-04-05 13:03:41 -07:00
Antón Molleda
7ac905dd77 docs: remove application-packaging.md (#28457)
This tutorial was removed as part of
https://github.com/electron/electron/pull/26239 but was not deleted when
the documentation was backported in
https://github.com/electron/electron/pull/28396
2021-03-31 01:33:29 -07:00
Antón Molleda
22f6abc4f5 docs: backport current tutorials to 12-x-y (#28396) 2021-03-30 11:53:59 -07:00
Erick Zhao
fc2762c66a docs: MessagePorts guide (#27678) (#28357)
Co-authored-by: Jeremy Rose <jeremya@chromium.org>
2021-03-24 10:44:50 +09:00
Will Anderson
7b21bc543b docs: Update Quick Start Guide for Electron 12 (#28227)
* docs: Update Quick Start Guide for Electron 12

With `contextIsolation` enabled by default in Electron 12, the Getting Started Guide no longer works as it is written. In order for the basic example to display values from `process.versions`, we need to add a `preload.js` to the example.

* Trigger Build
2021-03-18 15:12:27 +09:00
Jeremy Rose
c3bce9c664 feat: implement allowFileAccess loadExtension option (#27702)
Co-authored-by: Сковорода Никита Андреевич <chalkerx@gmail.com>
Co-authored-by: Samuel Maddock <samuel.maddock@gmail.com>
2021-02-16 15:20:20 -08:00
Milan Burda
889abd0c8e docs: update OSR max FPS number (#26805) (#27508)
Co-authored-by: Erick Zhao <erick@hotmail.ca>
2021-01-27 16:34:45 +09:00
Erick Zhao
897fd34253 docs: update devtools extension tutorial (#26326) (#27310)
* docs: update devtools extension tutorial

* Update docs/tutorial/devtools-extension.md

Co-authored-by: Jeremy Rose <nornagon@nornagon.net>

* update

Co-authored-by: Jeremy Rose <nornagon@nornagon.net>

Co-authored-by: Jeremy Rose <nornagon@nornagon.net>
2021-01-14 14:54:25 +09:00
trop[bot]
66a22a28a5 docs: fix relative link (#26601)
Co-authored-by: David Sanders <dsanders11@ucsbalum.com>
2020-11-19 12:41:26 -05:00
NotWearingPants
d4e53925ba docs: add a white background to body (#26504) 2020-11-18 11:54:26 -08:00
Shiranka Miskin
ec85a91472 docs: update contextIsolation documentation on access to globals (#19732) 2020-11-18 15:24:00 +09:00
Antonio
968cb970fc docs: restructured docs directory (#26335)
* docs: first draft of the restructred docs directory

* docs: first working version of the restructred docs directory

* docs: finalized version of the restructred docs directory

* docs: reverted architecture section back to the toc
2020-11-18 10:13:03 +09:00
Sofia Nguy
8594b55dee docs: update currently supported versions for 11.0.0 release (#26368) 2020-11-16 15:48:50 -08:00
Sofia Nguy
fabc51dc33 docs: update 12 stable dates (#26367) 2020-11-16 15:48:28 -08:00
loc
0b85fdf26c feat: add webContents.setWindowOpenHandler API (#24517)
Co-authored-by: Jeremy Rose <jeremya@chromium.org>
2020-11-10 09:06:03 -08:00
Michaela Laurencin
d836682ee6 docs: add native c++ windows debugging method (#26286) 2020-11-06 16:55:55 -08:00
David Sanders
43dbd1bdf8 chore: cleanup whitespace in docs (#26356) 2020-11-05 14:12:43 -08:00
David Sanders
3814a56d48 chore: fix markdown in docs (#26357) 2020-11-05 14:11:38 -08:00
David Sanders
ecd23bb29b docs: tidy up links (#26292) 2020-11-02 18:58:14 +09:00
Erick Zhao
f61dedb7e5 docs: update information on Linux support (#26265)
* docs: remove stale info from version support doc

* attempt to update binary info?
2020-11-02 16:24:34 +09:00
Antonio
6017a0de88 docs: revised dark mode feature page (#26187)
* docs: revised dark mode page

* docs: fixed lint errors in dark mode page

* docs: fixed mentions, revised doc structure in the dark mode feature page

* docs: fixed mentions, made all the steps more verbose in the dark mode feature page
2020-11-02 16:18:29 +09:00
Erick Zhao
935f6396d5 docs: clarify default value of enableRemoteModule (#26170) 2020-10-29 19:33:59 +09:00
Antonio
bb16c6f0be docs: revised the keyboard shortcuts feature page (#25999)
* docs: revised the keyboard shortcuts feature page

* docs: fixed mentions, revised sections and code samples

* docs: added example of before-input-event

* docs: fixed lint errors in keyboard shortcuts feature page

* docs: minor grammar fix in keyboard shortcuts feature page
2020-10-28 15:58:38 +09:00
Milan Burda
d2727f5aba feat: add support for UNNotificationResponse in app 'ready' event (#25950) 2020-10-28 04:25:10 +03:00
Samuel Attard
dbf2931f0e feat: Electron Fuses, package time feature toggles (#24241)
* feat: add new 'fuses' feature for package-time build-flag style feature control

* feat: put ENABLE_RUN_AS_NODE behind a fuse as well

* chore: address PR feedback

* build: move FUSE_EXPORT to headers

* build: use hex codes for kFuseWire char[]

* docs: add fuse wire documentation

* chore: update fuses.json info

* Apply suggestions from code review

Co-authored-by: Jeremy Rose <jeremya@chromium.org>

* chore: add link to fuse schema

* Update shell/app/electron_library_main.mm

Co-authored-by: Jeremy Rose <jeremya@chromium.org>

Co-authored-by: Jeremy Rose <jeremya@chromium.org>
2020-10-27 10:49:25 -07:00
Antonio
33ac7dbd48 docs: revised windows taskbar page (#26120)
* docs: revised windows taskbar page

* docs: fixed mentions related to windows taskbar
2020-10-27 10:31:40 +09:00
Antonio
e512669937 docs: revised linux desktop actions page (#26118) 2020-10-26 15:32:20 -05:00
Chris Patterson
6a0c5a8a65 docs: add snapcraft + electron-packager example (#25750)
* docs: add snapcraft + electron-packager example

Add example to snap electron app (electron-quick-start)
using snapcraft & electron-packager.

Include notes on how to apply this to an existing project.

Signed-off-by: Chris Patterson <chris.patterson@canonical.com>

* Update snapcraft.md

* Update snapcraft.md

* Update snapcraft.md

* Update docs/tutorial/snapcraft.md

Co-authored-by: John Kleinschmidt <jkleinsc@github.com>

Co-authored-by: Cheng Zhao <github@zcbenz.com>
Co-authored-by: John Kleinschmidt <jkleinsc@github.com>
2020-10-26 16:47:01 +09:00
Antonio
ecb758dae5 docs: revised the represented file feature page (#26018)
* docs: revised the represented file feature page

* docs: fixed mentions, updated screenshot to be more consistent
2020-10-26 16:45:45 +09:00
Antonio
722903f068 docs: revised the application progress bar feature page (#26003)
* docs: revised the application progress bar feature page

* docs: fixed mentions, added screenshots to make the guide more consistent

* docs: added an extra phrase about indeterminate mode

* docs: revised paragraph about indeterminate mode

* docs: fixed lint errors, broken links
2020-10-23 15:03:04 +09:00
Charles Kerr
c934d1386b docs: add discord link to docs community page (#26048) 2020-10-22 10:24:30 -05:00
Antonio
f93e33528e docs: revised the web embeds feature page (#26008)
* docs: revised the web embeds feature page

* docs: minor styling updates to the web embeds feature page

* docs: fixed text and grammar mentions

* docs: changed placement of the webviews warning

* docs: added a few missing commas
2020-10-22 11:08:26 +09:00
Antonio
5c6fa7e420 docs: revised the online-offline event detection feature page (#26017)
* docs: revised the online-offline event detection feature page

* docs: fixed text and grammar mentions
2020-10-21 15:46:56 +09:00
Antonio
aebb56cb33 docs: revised Notifications feature page (#25901)
* docs: revised Notifications feature page

* docs: fixed mentions and updated content according to style guide in the notifications feature page

* docs: fixed lint errors in the notifications feature page

* docs: slightly improved consistency of steps in the notifications feature page

* docs: fixed mentions in the notifications feature page
2020-10-20 11:24:27 +09:00
David Sanders
e6f570d191 docs: improve relative link linting and fix broken (#26020) 2020-10-20 10:46:27 +09:00
Antonio
89c04b3c6c docs: revised the macos dock menu feature page (#25985)
* docs: revised the macos dock menu feature page

* docs: added a cross-link to api, fixed mentions in the macos feature page
2020-10-20 10:32:40 +09:00