Commit graph

23 commits

Author SHA1 Message Date
David Sanders
3d2a754531
chore: extend linting of code blocks in the docs (#40245)
* chore: extend linting of code blocks in the docs

* chore: combine lint:markdownlint and lint:markdown scripts
2023-11-21 16:50:08 +09:00
Erick Zhao
2ac9ff1f20
docs: change MSDN links to new Microsoft docs (#37603) 2023-03-21 11:39:19 -04:00
David Sanders
a9c03950c0
docs: cleanup reference links (#36659) 2023-01-11 22:16:34 -08:00
Adrian Petrescu
ef463b39be
docs: Use inline image link in faq.md (#35413)
* Use absolute URL in faq.md image link

The relative link is rendered relative to the host domain, which works fine when viewing it on Github, but since you also use the same generated HTML in your doc site, the link is broken. See here: https://www.electronjs.org/docs/latest/faq#the-font-looks-blurry-what-is-this-and-what-can-i-do

Using an absolute URL here should fix the issue on the main site.

* Use inline image reference for subpixel rendering example

As suggested by @dsanders11
2022-09-12 16:09:12 -07:00
David Sanders
ecd23bb29b
docs: tidy up links (#26292) 2020-11-02 18:58:14 +09:00
Jeremy Rose
30cd9cdf2a
docs: remove reference to remote from faq (#24816) 2020-08-04 12:08:44 -07:00
Samuel Attard
eb6616e4e9
build: update to standard 14 (#24479) 2020-07-09 10:18:49 -07:00
Samuel Attard
b03bd8c45c
chore: rename atom things to electron things in our docs / scripts (#23100) 2020-04-13 14:32:29 -07:00
Charles Kerr
c83f836faf
refactor: prefer using app.whenReady() (#21972)
* docs: add references to app.whenReady() in isReady

* refactor: prefer app.whenReady()

In the docs, specs, and lib, replace instances of `app.once('ready')`
(seen occasionally) and `app.on('ready')` (extremely common) with
`app.whenReady()`.

It's better to encourage users to use whenReady():
1. it handles the edge case of registering for 'ready' after it's fired
2. it avoids the minor wart of leaving an active listener alive for
an event that wll never fire again
2020-02-03 22:43:22 +00:00
Jeremy Apthorp
662b94f46e
docs: windows don't need to be retained (#21957) 2020-01-30 14:15:35 -08:00
Charles Kerr
792f6b246c
docs: fix spelling and grammar errors (#18910) 2019-06-21 16:19:21 -05:00
John Kleinschmidt
23b0487e9b
docs: add missing image (#18235) 2019-05-13 16:55:41 -04:00
John Kleinschmidt
e63f527e76 docs: add FAQ entry about subpixel anti-aliased text (#18101)
* docs: add FAQ entry about subpixel anti-aliased text

Co-Authored-By: Nils-Hero Lindemann <nilsherolindemann@gmail.com>

* Fix linting errors

Co-Authored-By: Nils-Hero Lindemann <nilsherolindemann@gmail.com>

* Fix image link

Co-Authored-By: Nils-Hero Lindemann <nilsherolindemann@gmail.com>
2019-05-07 12:49:08 -07:00
Samuel Attard
558fff69e7
chore: update to standard 12 2018-09-14 14:57:01 +10: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
Toinane
0a0d88a5dc
remove all double spaces not needed 2017-11-29 11:58:24 +01:00
Charles Kerr
1b0c1842ca prefer sh to bash in the docs 2017-11-24 11:13:57 +01:00
Vanessa Yuen
435e027dc3 fix linting for fenced codeblocks only (see electron/electronjs.org#868) 2017-11-20 14:33:25 +08:00
Zeke Sikelianos
f5ed6c36cc add installation advice to FAQ 2017-07-18 13:23:03 -07:00
ArcticZeroo
64cc537951 Update faq.md
Fix the most horrible typo of all time
2017-04-22 23:11:04 -04:00
Zeke Sikelianos
06a354a2eb standardize all javascript blocks in English docs 2016-07-26 09:48:19 -07:00
Moriarty!~~
d10323b057 error link
> `[security introduction](../tutorial/security.md)`.
it should be `[security introduction](tutorial/security.md)`
2016-07-17 09:22:53 +08:00
Jessica Lord
00fab4688b Move and rename FAQ 2016-07-07 10:13:19 -07:00
Renamed from docs/faq/electron-faq.md (Browse further)