Commit graph

139 commits

Author SHA1 Message Date
Kevin Sawicki
f872799f5c Minor edits to clang-format guide 2016-10-07 14:05:33 -07:00
Haojian Wu
0d930b65f1 📝 clang-format on Electron C++ code. 2016-10-05 22:12:48 +02:00
Amitoj
a938859eb8 repl-docs: move file to tutorials
also add note for renderer processes.
2016-10-04 00:12:25 +05:30
Amitoj
002b9b5d4b add link to repl documentation 2016-10-02 23:47:11 +05:30
Zeke Sikelianos
61e50046bd link to the documentation styleguide 2016-09-19 21:10:36 -07:00
Zeke Sikelianos
1cdf8bbc10 break up run-on sentence 2016-09-19 21:09:31 -07:00
Zeke Sikelianos
a3d2cdaa2c website doesn't display docs for old versions any more 2016-09-19 21:09:02 -07:00
Cheng Zhao
2e8ccfd8df Add Offscreen Rendering to guides 2016-08-03 15:38:24 +09:00
Felix Rieseberg
c36bcf47d3 📝 Fix link to macOS Debugging Instructions 2016-08-01 19:15:03 -07:00
Felix Rieseberg
ab69ae07b7 📝 Add debugging instructions for macOS
I already wrote up debugging instructions for Windows, but never got
around to writing them for macOS - until now! This adds a very basic
introduction to LLDB from the command line, which should empower people
to figure out what’s happening inside Electron when they call an
Electron method from JavaScript.
2016-07-29 10:19:58 -07:00
mihaipocorschi
a3388b1d25 Fixed broken FAQ link in docs/README.md 2016-07-09 16:14:42 +03:00
vsemozhetbyt
9c5d36f0c6 One alphabetical reordering in the docs/README.md
📝 webContents, Tray -> Tray, webContents

If I get it right, only API TOCs should be ordered alphabetically,
so I've left other ones (Guides, Tutorials, Development) untouched.
I'm not so sure about API TOC Intro (three links below the "Synopsis"),
tell me if they should be sorted alphabetically too.

[ci skip]
2016-07-08 03:33:22 +03:00
Leonard Lamprecht
67dd19ed0f Replace OS X and Mac OS with macOS 2016-06-18 15:26:26 +02:00
Cheng Zhao
c7f5210b50 Merge pull request #5567 from felixrieseberg/versioning
Add Information about Versioning
2016-05-18 00:43:23 +00:00
Felix Rieseberg
7e09b1664a 📝 Add Information about Versioning 2016-05-17 20:20:25 +02:00
Felix Rieseberg
ffa5abe99b 📝 Add Windows Store Guide
This commit adds a guide about how to compile your app as a Windows Store app, analog to the Mac App Store guide.
2016-05-11 10:50:46 +02:00
Felix Rieseberg
02e8e929e1 📝 Add Security Tutorial
Add basic information about Electron and Security, including an
invitation to contribute to security features. Contains information by
@zcbenz, @zeke, and @paulcbetts.
2016-05-07 10:57:36 +01:00
Cheng Zhao
11653aa9c8 docs: systemPreferences 2016-04-25 15:36:38 +09:00
Felix Rieseberg
3c6e933231 📝 Add Debugging Instructions for Windows
Ref #5140
2016-04-13 15:39:05 -07:00
Felix Rieseberg
a3b8e81c21 📝 Add Headless CI Tutorial 2016-02-25 17:14:43 -08:00
foxy
e323c6dad9 update faq link 2016-01-07 22:26:21 +11:00
Cheng Zhao
554bb69101 Add FAQ 2016-01-05 19:57:15 +08:00
Cheng Zhao
fe87570876 docs: Using Widevine CDM Plugin 2015-12-30 16:10:00 +08:00
Cheng Zhao
04f7ceab73 Merge branch 'master' into desktop-capture-api 2015-12-08 12:43:44 +08:00
Cheng Zhao
6534a0e616 docs: Add Environment Variables 2015-11-26 20:37:48 +08:00
Eran Tiktin
df8cc85d2c Rephrased the note 2015-11-21 04:22:16 +02:00
Eran Tiktin
5730d588d0 Add a note to readme about docs versioning
Added a note to readme about using the correct docs version. Hopefully
this will reduce users confusion.
2015-11-21 03:31:52 +02:00
Cheng Zhao
eac2e7cc61 docs: Update codes in docs to use require('electron') 2015-11-12 21:20:09 +08:00
Cheng Zhao
90a7d4a906 docs: Update with new IPC modules 2015-11-10 16:48:24 +08:00
Roman Klauke
32523ae352 replace Mac with OS X
Commit 691d8dd replaced "Mac" with "OS X". This commit replaces some
other occurrences.
2015-10-16 22:03:47 +02:00
Cheng Zhao
18fd126c64 docs: Mac App Store Submission Guide 2015-10-16 17:16:12 +08:00
Haojian Wu
1e69ef79de Refine: make desktop-capturer as a renderer module. 2015-10-04 22:04:41 +08:00
Cheng Zhao
651009a1dc docs: Add "Supported Platforms" 2015-10-03 13:42:34 +08:00
Jessica Lord
b980650b6e Use headers so titles are linkable 2015-09-04 14:31:33 -07:00
Jessica Lord
b9da81ee6a Title Case 2015-09-04 13:50:26 -07:00
Jessica Lord
691d8dd9ab Replace "Mac" with "OS X" 2015-08-31 21:13:05 -07:00
Jessica Lord
bc909ddf5e Add new files to readme 2015-08-26 10:45:15 -07:00
Plusb Preco
dcd10d1e4b Translated API docs, added power-save-blocker API to README 2015-07-01 14:57:14 +09:00
Magica
1a8c0230a7 doc: Add pepper flash tutorial link in README. 2015-05-19 20:29:04 +08:00
Cheng Zhao
ab94c3f49e docs: Add "Build system overview" chapter 2015-04-11 12:11:57 +08:00
Joseph Dykstra
b6875ad49b Renamed browser-side to main process
renamed a few occurances of "web page" to "renderer"
renamed a few files that had "browser" in their name to "main-process"
note that there are still many occurances of web page.
2015-03-26 10:20:31 -05:00
Cheng Zhao
24d615d428 docs: Add a "s" 2015-03-19 11:25:53 +08:00
Cheng Zhao
b19cfba98e Merge pull request #1240 from suyash/rename-node-webkit-to-nwjs
rename node-webkit to NW.js in development docs
2015-03-18 18:01:37 +08:00
Cheng Zhao
af0690fb88 docs: "Quick start" should also be a "tutorial"
Guides should include information that not available in the API
references, and tutorials should be step-by-step walkthrough or
introductory text on certain APIs.
2015-03-17 18:41:54 +08:00
Cheng Zhao
c80aaa2980 docs: Separate guides and tutorials 2015-03-17 18:37:32 +08:00
Suyash
327c7bc3cc 📝 avoid breaking everyone's stuff 2015-03-16 16:50:23 +05:30
Suyash
cda129b073 📝 rename node-webkit to NW.js in development docs
Replaces all occurences of node-webkit with NW.js in the development
docs.
2015-03-12 01:58:58 +05:30
Cheng Zhao
2d6dd9f4d2 docs: Put window.open docs in its own chapter, regards #1137 2015-03-04 08:47:04 -08:00
Cheng Zhao
8093300a43 docs: Use NativeImage to replace Image 2015-02-12 13:52:28 +08:00
Cheng Zhao
21fa395b61 docs: Add "Desktop environment integration" 2014-11-17 21:40:07 +08:00
Cheng Zhao
621867e518 docs: Setting up symbol server in debugger 2014-11-10 16:09:13 +08:00
Brent Ertz
9cf3811a56 Add tutorial on online/offline event detection 2014-11-05 07:49:50 -07:00
Stefan Buck
eaa5e136b6 fix broken links 2014-10-27 22:43:29 +01:00
Cheng Zhao
69bcc8e831 Add docs on our custom web elements 2014-10-25 14:58:32 +08:00
Cheng Zhao
4ccb0cccf3 Rename web-view module to web-frame 2014-10-24 18:45:03 +08:00
Cheng Zhao
5a0be6672d docs: Add reference on app packaging 2014-09-29 21:34:54 +08:00
Cheng Zhao
268508764f docs: use => using 2014-09-13 00:16:32 +08:00
Cheng Zhao
34109fa741 docs: Document how to use chromedriver. 2014-09-13 00:07:21 +08:00
Cheng Zhao
80fb44b926 docs: Add docs on how to use chrome devtools extension. 2014-08-28 16:33:27 +08:00
Cheng Zhao
6e3b3fa5a2 Add "Debugging browser process" chapter. 2014-08-20 10:01:43 +08:00
Cheng Zhao
86dd8e2dfa docs: Document the chrome command switches we support. 2014-08-15 13:06:52 +08:00
Cheng Zhao
2125a0be82 docs: Sort modules in alphabet sequence. 2014-08-05 00:05:26 +08:00
Haojian Wu
681de1b048 📝 Update global-shortcut API document. 2014-08-04 10:11:00 +08:00
Cheng Zhao
9c038a2402 Merge pull request #534 from hokein/hotkey
Implement global shortcut API, fixes #439
2014-08-03 22:34:59 +08:00
Cheng Zhao
70aad83b07 Add docs on content-tracing module. 2014-07-31 15:40:40 +08:00
Haojian Wu
9342d59a7c 📝 Shortcut API document. 2014-07-31 09:12:43 +08:00
Cheng Zhao
27d73b362a Markdown in website is rendered differently 2014-06-24 11:24:40 +08:00
Cheng Zhao
ab1670ff03 💄 Fix the links 2014-06-24 11:22:09 +08:00
Cheng Zhao
d3c76d6998 📝 Add the presentation link given on HuJS. 2014-06-24 11:18:45 +08:00
Cheng Zhao
0bc8251e1b 📝 Document the web-view module. 2014-06-16 14:56:24 +08:00
Cheng Zhao
884f30010c 📝 Document the tray module. 2014-06-02 11:47:22 +08:00
Cheng Zhao
542e795fe0 📝 Mention atom-shell's changes to the process object. 2014-05-23 22:56:56 +08:00
Cheng Zhao
d2f3d83678 💄 Remove redundant empty line. 2014-05-06 15:20:47 +08:00
Cheng Zhao
5eb2b33018 📝 Add technical differences to node-webkit, fixes #242. 2014-05-06 15:16:54 +08:00
Cheng Zhao
5c55b9412f 📝 Add Synopsis chapter. 2014-05-05 14:49:05 +08:00
Cheng Zhao
5933947000 📝 Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00
Cheng Zhao
37275c64cd 📝 Mention 64/32 bit support on each platform. 2014-05-05 09:48:44 +08:00
Cheng Zhao
69821cdb96 📝 Separate the application distribution chapter out. 2014-05-04 18:32:12 +08:00
Cheng Zhao
f7cf3ad867 Restructure the docs to put more tutorials. 2014-04-30 14:52:58 +08:00
Cheng Zhao
2b82eafff4 📝 Update docs on using native modules. 2014-02-20 18:51:57 +08:00
Cheng Zhao
94b3de557e 📝 Add docs on building for Linux. 2014-02-20 18:39:24 +08:00
Cheng Zhao
95b2003193 📝 Add docs on screen module. 2014-01-07 20:35:13 +08:00
Cheng Zhao
5b12f80d01 Discard the require('atom-delegate') API. 2013-12-17 22:08:45 +08:00
Cheng Zhao
62f200d252 Mention in doc that crash-reporter is available for renderer. 2013-11-13 17:30:49 +08:00
Cheng Zhao
92241b91ce doc: Separate pages into sub directories. 2013-09-09 15:49:13 +08:00
Cheng Zhao
128d9c78db Add documentation for protocol module. 2013-09-03 18:22:40 +08:00
probablycorey
44cd21f0fd Normalize document names 2013-08-14 15:57:52 -07:00
probablycorey
41b57c673e Convert wiki links to relative markdown links 2013-08-14 15:52:00 -07:00
probablycorey
6bc2a3a5e8 Move wiki content to docs dir 2013-08-14 15:43:35 -07:00