mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
28180 commits 1 branch 183 tags 5.3 GiB
Commit graph

119 commits

Author SHA1 Message Date
Bogdan Cerovac
42087e306c
fix: add language to html in quick-start.md (#41225) 
Add language to html in quick-start.md

We must define language in HTML for different reasons (accessibility++)
 2024-02-08 10:27:50 +09:00
Alex Browne
0b5fceb50e
docs: update quick-start.md (#40556) 
Updates the Quick Start guide to specify _where_ JavaScript code is supposed to be added. This is more descriptive than just "your file".
 2023-11-22 15:19:39 +09:00
NoxFly
624ae024e2
docs: Quick Start | Electron Forge chapter requirements updated (#39639) 
* Update quick-start.md

Added a note to a pre-require of Electron Forge.
Otherwise users will have an error `Cannot make for rpm, the following external binaries need to be installed: rpmbuild`

* Add two required steps for Electron Forge to build without errors

* Update docs/tutorial/quick-start.md

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

---------

Co-authored-by: Erick Zhao <erick@hotmail.ca>
 2023-09-27 08:56:39 +09:00
Erick Zhao
b8ac798344
docs: use node: imports for node core modules (#39681) 
docs: use `node:` imports for node builtin modules
 2023-08-30 11:55:23 -04:00
David Sanders
905aad9cb6
chore: type check JS in docs (#38423) 
* build(deps): update @electron/lint-roller

* chore: type check JS in docs

* docs: add @ts-check and @ts-expect-error to code blocks

* chore: fix type check errors in docs

* chore: add ts-type to blocks
 2023-06-05 16:26:26 +09: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
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
Johns Gresham
8ad1470d08
docs: remove extra $ from npm install command (#33366) 2022-03-23 08:54:08 +09: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
Oran C
195d2b5b3e
[fix] Docs rendering issue with rendering on electronjs quick-start (#32293) 
there is a issue with rendering on the bottom of page https://www.electronjs.org/docs/v14-x-y/tutorial/quick-start
which looks like this
![](https://dl3.pushbulletusercontent.com/MXsLhjaoKRj1bhu4R73E3WLiuKCBMkgh/image.png)

all id did is remove the spacing and it should fix the issue. sometimes having spaces before a "```" will cause issues

hope this helps!
 2022-01-03 11:18:02 -08:00
Jack Nemitz
1d8612ad5d
Fix typo in quick-start.md (#32282) 
Resolve a grammar issue in the quick-start guide.
 2022-01-03 09:59:55 +01:00
Matthew Shen
c0e72bd335
docs: update to the use of arrow functions in line with the style guide (#30194) 
* docs: Update to the use of arrow functions in line with the style guide

* docs: Fixed unmatched bracket typo in previous commit 9ebe3e58f7948c6636d77f3c58a2693683b69691

* fix linting

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>
 2021-08-02 10:57:37 +09:00
Davenury
75b4267aa9
Update quick-start.md (#30064) 
Change app-quit link definition, so both window-all-closed and app-quit redirects to appropriate sites.
 2021-07-14 20:59:32 +09:00
aydon
9fcdb06272
Update quick-start.md (#29333) 
In version 13.0.1 preload process should added to webPreferences.
 2021-05-27 11:46:32 -07:00
Erick Zhao
bb26060564
docs: fix link to docs/fiddle/quick-start (#29325) 2021-05-27 09:45:23 +09:00
Erick Zhao
6330f8be9f
docs: rework introduction docs (#29062) 
* 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

Co-authored-by: Cheng Zhao <github@zcbenz.com>
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
 2021-05-24 11:32:36 +09:00
KSneijders
f755c521eb
Defined the name of the preload script (#28597) 2021-04-11 14:01:36 -07:00
Will Anderson
14acf00ba9
docs: add missing curly brace to quick start example code (#28253) 2021-03-18 00:58:03 -07:00
Will Anderson
b6ff12ef7f
docs: update Quick Start Guide for Electron 12 (#28223) 
* 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.

* fix: annotate preload code block with a language

* docs: update quick-start Fiddle example to use preload to provide version info

* fix: ensure example files end in a newline

* docs: add security warning to instructions for turning off contextIsolation

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

* docs: treat preload as an adjective instead of a noun

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

Co-authored-by: John Kleinschmidt <jkleinsc@github.com>
 2021-03-16 19:45:38 -04:00
Mark Lee
6bce814736
docs(quick-start): make import command npm 7-compatible (#28077) 
With npm 7, just running `npx @electron-forge/cli import` results in:

```
npm ERR! could not determine executable to run
```
 2021-03-12 16:38:58 +09:00
choko
e250a2d804
docs: include author and description in package.json in quick-start.md (#26983) 
* Update quick-start.md

`author` and `description` field is required

* Update quick-start.md

* Update quick-start.md

Co-authored-by: Cheng Zhao <github@zcbenz.com>
 2020-12-16 19:02:06 +09:00
diego
b73b343e29
docs: update quick start description after fiddle integration (#26943) 2020-12-15 11:12:57 +09:00
windwalkr
6001f03e46
docs: add description to read-me.md (#26823) 
Unhandled exception error is received if description is not defined while running "npm run make."  Defining a description solves this issue.
 2020-12-08 13:26:29 +09:00
Antonio
fadd513739
docs: added fiddle support for code samples (#26501) 
* docs: added fiddle support for code samples in quick start guide and features

* docs: removed excessive fiddle links for not final steps

* docs: added eof newlines to fiddle examples

* docs: reworked fiddle examples to be more self-sufficient

* docs: reworked fiddle examples according to mentions

* docs: changed http to https in the offscreen rendering fiddle

* docs: fix recent documents fiddle to be more consistent
 2020-11-30 16:48:39 +09:00
NotWearingPants
d4e53925ba
docs: add a white background to body (#26504) 2020-11-18 11:54:26 -08:00
Milan Burda
d2727f5aba
feat: add support for UNNotificationResponse in app 'ready' event (#25950) 2020-10-28 04:25:10 +03:00
Antonio
8dfb1cf78f
docs: revised version of the quick start guide (#25760) 2020-10-13 13:15:40 -07:00
Mod John
2a161e1725 Fix broken link (#12387) 
* Fix broken link

Link was producing a 404 error as the file no longer exists. Wasn't sure where this intended link used to go so took a guess at a appropriate target.

* Update quick-start.md
 2018-05-16 10:23:46 -07:00
Charles Kerr
4d078fdb03
Remove more words (#12852) 
* remove 'basically' from docs

* remove 'simply' from docs

* remove most uses of 'just' from docs
 2018-05-08 00:16:09 -05:00
Felix Rieseberg
64fc523977 📝 Fix dead links 2018-02-19 18:25:02 -06:00
Felix Rieseberg
d7360e3203 📝 Ensure that quick-start.md still exists 2018-02-19 17:14:31 -06:00
Charles Kerr
1b0c1842ca prefer sh to bash in the docs 2017-11-24 11:13:57 +01:00
Charles Kerr
70643a865b
Merge pull request #11178 from electron/fenced-code-block-lang 
enforce rules on code blocks style in docs
 2017-11-21 13:38:46 +01:00
Vanessa Yuen
435e027dc3 fix linting for fenced codeblocks only (see electron/electronjs.org#868) 2017-11-20 14:33:25 +08:00
Ronald Eddy
14c6e78147 Update electron.atom.io -> electronjs.org 
Update electron.atom.io -> electronjs.org to reduce redirects and speed navigation.
 2017-11-19 04:01:33 -08:00
robbix1206
0bcc5d37ab Put npx as last option 2017-09-16 15:37:26 +02:00
robbix1206
564ca27679 Forget a # 2017-09-16 14:09:31 +02:00
robbix1206
9fecf4b2f7 Add npx command for node version 8.2.0 and later 2017-09-16 14:03:09 +02:00
Liam Griffin
3decb5eb28 Remove bash from windows commands to prevent syntax highlighting errors (#1) 2017-06-20 15:25:42 +01:00
Hum4n01d
a694110d48 Fix order of OSs 
It was previously inconsistent
 2017-05-08 13:36:28 -07:00
Zeke Sikelianos
69f0cb26e7 use https for all Electron website URLs 2017-02-28 21:19:55 -08:00
Kevin Sawicki
e9a2792b55 Format URL passed to BrowserWindow.loadURL 2016-10-31 11:34:53 -07:00
Kevin Sawicki
8d194691fe Add separate platform examples for running electron 2016-08-26 14:16:30 -07:00
Elias
1fe3b70a23 fix windows command prompt error 
path to electron needs to be wrapped in quotes or else windows command prompt will error out
 2016-08-22 00:29:33 -07:00
Jessica Lord
3ebd5fbd8f Update docs re: electron module update 2016-08-16 15:57:07 -07:00
Zeke Sikelianos
06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07:00
Zeke Sikelianos
ee677ea212 link to boilerplates 2016-07-14 14:57:06 -07:00
Plusb Preco
039aebb74a 📝 Fix isolated link 
[ci skip]
 2016-07-13 02:59:29 +09:00
Maik Ellerbrock
01cb024f44 fix broken link 
fixed broken link "how to share data between web pages" in section "Differences Between Main Process and Renderer Process"
 2016-07-12 07:31:18 +08:00
Sudar Abisheck
0e1caa5961 Update quick-start.md 
Corrected the anchor text
 2016-06-24 11:29:55 +05:30