Commit graph

1050 commits

Author SHA1 Message Date
John Kleinschmidt
697a219bcb
feat: add support for Web Bluetooth pin pairing (#35416)
* feat: add bluetooth pairing handler

* Update docs/api/session.md

Co-authored-by: Charles Kerr <charles@charleskerr.com>

* Update docs/api/session.md

Co-authored-by: Charles Kerr <charles@charleskerr.com>

* docs: update based on review

* Apply suggestions from code review

Co-authored-by: Erick Zhao <erick@hotmail.ca>
Co-authored-by: Charles Kerr <charles@charleskerr.com>

* chore: update docs per review

* chore: cleanup callback per review

Co-authored-by: Charles Kerr <charles@charleskerr.com>
Co-authored-by: Erick Zhao <erick@hotmail.ca>
2022-09-26 10:19:58 -04:00
Dominik Ilja
7d96321786
docs: minor grammar fixes in tutorial (#35804) 2022-09-26 10:53:08 +02:00
Keeley Hammond
22d6102702
docs: update E22 release dates (#35773)
* doc: update E22 release dates

* chore: update 18.0.0 supported chart
2022-09-23 11:38:02 -07:00
Cyril Chukwuebuka
d357218654
docs: changed event.data to data under the message.port in docs (#35086)
* docs: changed event.data to data under the message.port in docs

* docs: corrected BrowserWindow wrong usage and change window.messagePort to window.electronMessagePort
2022-09-23 01:07:53 -07:00
Aman Gupta
0df8878da4
docs: update the link for Introduction to Node.js (#35761)
Updated the link for Introduction to NodeJs
2022-09-22 09:46:11 -07:00
George Xu
4ffdd284c3
docs: add forge-overview.md (#35473)
* docs: move forge-specific docs to electronforge.io

* docs: add reference to forge icon tutorial

* docs: add references to forge-overview.md

* docs: add recommended

* docs: update forge-overview

* docs: apply code review comments

Co-authored-by: Charles Kerr <charles@charleskerr.com>
2022-09-21 16:49:22 -04:00
Alexander Prinzhorn
9719cea250
docs: remove claim that HTTPS authenticates the remote server (#35526)
Update security.md

I don't think this is accurate. This is not a feature of HTTPS. This would require certificate pinning. It has been in the security docs since 2db125890c

Related

https://github.com/electron/electron/issues/3330
https://www.npmjs.com/package/electron-ssl-pinning
https://cheatsheetseries.owasp.org/cheatsheets/Pinning_Cheat_Sheet.html
2022-09-21 16:19:04 -04:00
Sebastian Vittersø
b1d7b30ca3
docs: fix wording mistake in security.md section 4 (#35682)
Update security.md

Under "4. Process Sandboxing", it said "For mor information on what `contextIsolation` is..." which was the previous section (copied from there). This updates it to say "For more information on what Process Sandboxing is..."
2022-09-20 11:14:44 -04:00
Jeremy Rose
fa3cd17475
docs: reverse support matrix order (#35699) 2022-09-15 15:53:26 -07:00
Ryan Manuel
f25c87dc70
feat: allow custom v8 snapshots to be used in the main process and the default snapshot in the renderer process (#35266)
* Updates to allow for using a custom v8 snapshot file name

* Allow using a custom v8 snapshot file name

* Fix up patch due to merge

* Use fuse to set up custom v8 snapshot file in browser process

* Refactor to use delegate instead of command line parameter

* Refactoring

* Update due to merge

* PR comments

* Rename patch

* Rename patch
2022-09-15 13:21:16 -07:00
Cheng Zhao
748c6af61e
docs: add back docs about asar archives (#35563) 2022-09-13 14:00:42 -07:00
Aryan Shridhar
f244e75927
docs: add IPC validation guideline link in checklist (#35573) 2022-09-13 13:56:41 -07:00
Shyamkumar Yadav
c847229a7e
docs: Markdown linting and typo (#35568)
* Fix reference definitions should be needed

* typo

* typo

* typo and style

* Fix reference definitions should be needed

* Fix typo

* restore to previous
2022-09-13 13:49:11 -07:00
Benjamin Pasero
6ec4c7e563
docs: add performance advice to disable default menu creation (#35525) 2022-09-12 15:29:42 -07:00
CanadaHonk
a0c20fef96
docs: fix misspelling in fuses (#35609) 2022-09-08 15:33:58 -07:00
Erick Zhao
34cb360730
docs: update sandbox renderer defaults for Electron 20 (#35379)
* docs: update E20 sandbox rendering defaults

* docs: update tutorial

* simplify paragraph

* dont mention context isolation
2022-09-08 13:21:50 -07:00
Samuel Attard
142eb89d5e
docs: add fuses and asar integrity docs (#35528) 2022-09-07 08:41:03 -07:00
Gregory R. Wroblewski
c16baa063a
docs: fix missing includes in code example (#35479) 2022-09-07 15:37:29 +02:00
Nik K
23264488c5
docs: update docs description to match sidebar (#35144)
Update introduction.md
2022-08-29 17:17:58 +09:00
Rhitik Bhatt
4cb57ad1a0
docs: removes unused import in preload script (#35324)
* Remove unused import of path

This import gives out the error in the preload script:

Error: module not found: path
    at preloadRequire

* Removes unused import in preload script

notes: Removes unused import which causes issue in preload script of drag and drop tutorial

* Remove import path as it is not used in the script

note: Removes import path as it is not used in the script
2022-08-15 15:23:59 +09:00
Trang Le
32fefb1f50
fix(docs): fix a typo in section on debugging with VSCode (#35256)
fix(docs): fix a typo
2022-08-09 15:01:38 -04:00
TAN
c47031a279
docs: Fix the URL bugs at tutorial-6-publishing-updating.md (#35175)
* Update tutorial-6-publishing-updating.md

The dot at the end of the URL will depend on the site that cannot open. Because it will open `https://update.electronjs.org./` which does not exist.

* docs: fix the URL problems at tutorial-6-publishing-updating.md

The dot at the end of the URL will depend on the site that cannot open. Because it will open `https://update.electronjs.org./` which does not exist.

* docs: fix the URL problems at tutorial-6-publishing-updating.md

* docs: fix the URL problems at tutorial-6-publishing-updating.md
2022-08-03 10:20:37 -04:00
Erick Zhao
74432a313c
docs: fix link in tutorial (#35192)
Relands https://github.com/electron/electronjs.org-new/pull/240 upstream
2022-08-03 10:12:06 -04:00
Maya Nedeljković Batić
fb39f241fb
docs: update categories to match sidebar (#35196)
This page describes each of the categories available in the sidebar, but some of the category titles didn't match.
2022-08-03 12:03:45 +02:00
Kilian Valkhof
00e9bf107a
docs: new main -> renderers messageChannel example (#34978)
* docs: new main -> renderers messageChannel example

* consistent use of your

* fix a typo

* linting

* markdown linting

* Update docs/tutorial/message-ports.md

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

* update code example headings, reference contextIsolation example

* remove nodeIntegration: false from browserWindows

* rename "messagePort" to "electronMessagePort" for compatibility

Co-authored-by: Erick Zhao <erick@hotmail.ca>
2022-07-29 09:47:43 -07:00
Sofia Nguy
7f757075bc
docs: update E21 release date (#35122)
* docs: update E21 release date

* chore: fix lint

Co-authored-by: Keeley Hammond <khammond@slack-corp.com>
2022-07-28 21:54:48 -07:00
Mike Lee
49302e4a2f
docs: Add missing link to tutorial page (#35035)
Add missing link to tutorial page
2022-07-25 11:22:06 +02:00
David Sanders
c418275228
chore: update Discord invite links (#34730) 2022-07-05 11:55:15 -04:00
David Sanders
98cd16d336
chore: fix typos (#34731) 2022-07-05 11:49:56 -04:00
David Sanders
39840502be
docs: replace broken Windows taskbar images (#34729) 2022-06-27 14:14:01 +02:00
Erick Zhao
e410109a3d
docs: expand tutorial (#34604)
* docs: base tutorial update

* more docs

* zzz

* remove unused images
2022-06-22 17:17:48 +09:00
Josh Soref
ea4278754c
chore: fix spelling errors in multiple files (#34574)
* chore: fix spelling in .circleci

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* chore: fix spelling in BUILD.gn

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* chore: fix spelling in appveyor.yml

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* chore: fix spelling in build

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* chore: fix spelling in docs

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* chore: fix spelling in lib

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* chore: fix spelling in script

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* chore: fix spelling in shell

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* chore: fix spelling in spec

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

* chore: fix spelling in spec-main

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
2022-06-16 16:46:11 +09:00
Michaela Laurencin
52c0a4fafc
docs: add macOS height option info (#34451) 2022-06-09 15:17:27 -04:00
FantasqueX
89fab6a549
docs: remove X-Content-Security-Policy header in quick-start.md (#34307)
reference: Note: It is known that having both Content-Security-Policy
 and X-Content-Security-Policy or X-Webkit-CSP causes unexpected
 behaviours on certain versions of browsers. Please avoid using deprecated
 X-* headers. https://content-security-policy.com/
also:
1ad18486ed
2022-05-23 14:49:38 +02:00
Michaela Laurencin
aa3e852a73
docs: add height option and color transparency info (#34278) 2022-05-23 20:01:22 +09:00
Sofia Nguy
455544dfb6
docs: Update release dates for E20 (#34267) 2022-05-18 09:39:40 -07:00
John Kleinschmidt
4f8a843606
docs: clarify added/removed events on device APIs (#34177) 2022-05-11 13:01:56 -07:00
FantasqueX
6063d4f8df
docs: fix typo in quick-start.md (#34149)
According to Jetbrains LanguageTool, "Consider using All the. "
2022-05-11 10:05:59 -04:00
Samuel Attard
2d0ad04354
docs: update security guide regarding ctx isolation (#33807) 2022-04-18 10:09:54 -04:00
Inclusive Coding Bot
68d6d8d451
chore: switch to gender neutral terms (#33532)
* Switch to gender neutral terms

* Update docs/api/web-contents.md

Co-authored-by: Milan Burda <milan.burda@gmail.com>

* Update docs/api/webview-tag.md

Co-authored-by: Milan Burda <milan.burda@gmail.com>

* Update script/release/uploaders/upload.py

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

* Update docs/tutorial/in-app-purchases.md

Co-authored-by: Milan Burda <milan.burda@gmail.com>

Co-authored-by: inclusive-coding-bot <inclusive-coding-bot@github.com>
Co-authored-by: Milan Burda <milan.burda@gmail.com>
Co-authored-by: John Kleinschmidt <jkleinsc@github.com>
2022-04-06 17:19:32 -04:00
Baitinq
c4e3a1aad3
docs: Use Node's URL parser in the 5th security recommendation (#33463)
Rule 13 recommends using Node's URL parser for handling url inputs. At
the moment, this is not being followed in the code example for rule 5,
which falls back on checking that the url ends with a '/'. If this was
forgotten when a user copies this code it could introduce security
vulnerabilities if an attacker uses an URL in the following way:

"https://example.com.attacker.com"

Using Node's URL parser fixes this potential missuse and enables the
'/' to be omited from the code example.

Co-authored-by: Baitinq <you@example.com>
2022-03-28 14:25:44 -04:00
Sofia Nguy
9e45a1cd51
docs: Update release dates for E19 and fix typos (#33464) 2022-03-28 09:30:05 -07:00
Samuel Attard
800b96fe14
docs: add new IPC validation section to the security tutorial (#33369)
* docs: add new IPC validation section to the security tutorial

* Update security.md

* Update docs/tutorial/security.md

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

* Update docs/tutorial/security.md

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

Co-authored-by: Erick Zhao <erick@hotmail.ca>
2022-03-22 20:45:23 -04:00
Johns Gresham
8ad1470d08
docs: remove extra $ from npm install command (#33366) 2022-03-23 08:54:08 +09:00
Lalit
e100402b13
docs: possible change in tutorial/ipc (#33218)
The `counter` channel should be `update-counter` channel
2022-03-21 11:13:55 +09:00
David Sanders
7acb513ba6
docs: update links to Chromium source (#33309) 2022-03-17 13:45:55 +01:00
Jeremy Rose
4342b7ff55
chore: remove awkward semi-documented preloadURL WebPreference (#33228) 2022-03-16 16:23:41 -07:00
Abhay Gupta
b274011720
fix: fiddle ipc code pattern 3 (#33262) 2022-03-16 11:01:29 -04:00
Aryan Shridhar
7382891015
docs: reword sentence for better understanding (#33265) 2022-03-15 10:11:40 -07:00
Alvin Philips
41c81ed066
docs: Updated list numbering (#32991)
* docs: Updated list numbering

The steps to package and distribute an application using electron had incorrect numbering

* Indented text within ordered list sections

* Removed single space

* Fixed indentation
2022-03-03 15:35:51 -08:00