This repository has been archived by the owner on Jan 4, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 109
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
181 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
Будь ласка, переконайтесь що ви використовуєте документацію, яка відповідає вашій версії Electron. | ||
Номер версії повинен бути присутнім в URL адресі сторінки. Якщо це не так, Ви можливо, | ||
використовуєте документацію із development гілки, | ||
яка може містити зміни в API, які не сумісні з вашою версією Electron. | ||
Якщо це так, тоді Ви можете переключитись на іншу версію документації | ||
із списку [доступних версій](http://electron.atom.io/docs/) на atom.io, | ||
або якщо ви використовуєте інтеррфейс GitHub, | ||
тоді відкрийте список "Switch branches/tags" і виберіть потрібну вам | ||
версію із списку тегів. | ||
|
||
## Довідник | ||
|
||
* [Підтримувані платформи](tutorial/supported-platforms.md) | ||
* [Application Distribution](tutorial/application-distribution.md) | ||
* [Mac App Store Submission Guide](tutorial/mac-app-store-submission-guide.md) | ||
* [Упаковка додатку](tutorial/application-packaging.md) | ||
* [Використання Native Node модулів](tutorial/using-native-node-modules.md) | ||
* [Debugging Main Process](tutorial/debugging-main-process.md) | ||
* [Використання Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md) | ||
* [DevTools Extension](tutorial/devtools-extension.md) | ||
* [Використання Pepper Flash плагіну](tutorial/using-pepper-flash-plugin.md) | ||
|
||
## Підручники | ||
|
||
* [Швидкий старт](tutorial/quick-start.md) | ||
* [Desktop Environment Integration](tutorial/desktop-environment-integration.md) | ||
* [Online/Offline Event Detection](tutorial/online-offline-events.md) | ||
|
||
## API References | ||
|
||
* [Synopsis](api/synopsis.md) | ||
* [Process Object](api/process.md) | ||
* [Supported Chrome Command Line Switches](api/chrome-command-line-switches.md) | ||
* [Environment Variables](api/environment-variables.md) | ||
|
||
### Користувальницькі елементи DOM | ||
|
||
* [`File` Object](api/file-object.md) | ||
* [`<webview>` Tag](api/web-view-tag.md) | ||
* [`window.open` Function](api/window-open.md) | ||
|
||
### Модулі для Main Process: | ||
|
||
* [app](api/app.md) | ||
* [autoUpdater](api/auto-updater.md) | ||
* [BrowserWindow](api/browser-window.md) | ||
* [contentTracing](api/content-tracing.md) | ||
* [dialog](api/dialog.md) | ||
* [globalShortcut](api/global-shortcut.md) | ||
* [ipcMain](api/ipc-main.md) | ||
* [Menu](api/menu.md) | ||
* [MenuItem](api/menu-item.md) | ||
* [powerMonitor](api/power-monitor.md) | ||
* [powerSaveBlocker](api/power-save-blocker.md) | ||
* [protocol](api/protocol.md) | ||
* [session](api/session.md) | ||
* [webContents](api/web-contents.md) | ||
* [Tray](api/tray.md) | ||
|
||
### Модулі для Renderer Process (Web Page): | ||
|
||
* [ipcRenderer](api/ipc-renderer.md) | ||
* [remote](api/remote.md) | ||
* [webFrame](api/web-frame.md) | ||
|
||
### Модулі для Both Processes: | ||
|
||
* [clipboard](api/clipboard.md) | ||
* [crashReporter](api/crash-reporter.md) | ||
* [nativeImage](api/native-image.md) | ||
* [screen](api/screen.md) | ||
* [shell](api/shell.md) | ||
|
||
## Розробка | ||
|
||
* [Стиль кодування](development/coding-style.md) | ||
* [Source Code Directory Structure](development/source-code-directory-structure.md) | ||
* [Technical Differences to NW.js (formerly node-webkit)](development/atom-shell-vs-node-webkit.md) | ||
* [Build System Overview](development/build-system-overview.md) | ||
* [Build Instructions (OS X)](development/build-instructions-osx.md) | ||
* [Build Instructions (Windows)](development/build-instructions-windows.md) | ||
* [Build Instructions (Linux)](development/build-instructions-linux.md) | ||
* [Setting Up Symbol Server in debugger](development/setting-up-symbol-server.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
# Electron Documentation Styleguide | ||
|
||
Find the appropriate section for your task: [reading Electron documentation](#reading-electron-documentation) | ||
or [writing Electron documentation](#writing-electron-documentation). | ||
|
||
## Написання документації для Electron | ||
|
||
Існує кілька способів за допомогою яких ми ствоюємо документацію для Electron. | ||
|
||
- Maximum one `h1` title per page. | ||
- Use `bash` instead of `cmd` in code blocks (because of syntax highlighter). | ||
- Doc `h1` titles should match object name (i.e. `browser-window` → | ||
`BrowserWindow`). | ||
- Hyphen separated filenames, however, are fine. | ||
- No headers following headers, add at least a one-sentence description. | ||
- Methods headers are wrapped in `code` ticks. | ||
- Event headers are wrapped in single 'quotation' marks. | ||
- No nesting lists more than 2 levels (unfortunately because of markdown | ||
renderer). | ||
- Add section titles: Events, Class Methods and Instance Methods. | ||
- Use 'will' over 'would' when describing outcomes. | ||
- Events and methods are `h3` headers. | ||
- Optional arguments written as `function (required[, optional])`. | ||
- Optional arguments are denoted when called out in list. | ||
- Line length is 80-column wrapped. | ||
- Platform specific methods are noted in italics following method header. | ||
- ```### `method(foo, bar)` _OS X_``` | ||
- Prefer 'in the ___ process' over 'on' | ||
|
||
### Переклад документації | ||
|
||
Переклади документації знаходяться в дерикторії `docs-translations`. | ||
|
||
Щоб додати переклад (або частковий переклад) документації: | ||
|
||
- Create a subdirectory named by language abbreviation. | ||
- Within that subdirectory, duplicate the `docs` directory, keeping the | ||
names of directories and files same. | ||
- Translate the files. | ||
- Update the `README.md` within your language directory to link to the files | ||
you have translated. | ||
- Add a link to your translation directory on the main Electron [README](https://github.com/atom/electron#documentation-translations). | ||
|
||
## Читання документації Electron | ||
|
||
Кілька порад для того щоб легше зрозуміти синтаксис документації Electron. | ||
|
||
### Методи | ||
|
||
Приклад [методу](https://developer.mozilla.org/en-US/docs/Glossary/Method) | ||
в документації: | ||
|
||
--- | ||
|
||
`methodName(required[, optional]))` | ||
|
||
* `require` String, **required** | ||
* `optional` Integer | ||
|
||
--- | ||
|
||
The method name is followed by the arguments it takes. Optional arguments are | ||
notated by brackets surrounding the optional argument as well as the comma | ||
required if this optional argument follows another argument. | ||
|
||
Below the method is more detailed information on each of the arguments. The type | ||
of argument is notated by either the common types: | ||
[`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), | ||
[`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), | ||
[`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), | ||
[`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) | ||
or a custom type like Electron's [`webContent`](api/web-content.md). | ||
|
||
### Події | ||
|
||
Приклад [події](https://developer.mozilla.org/en-US/docs/Web/API/Event) | ||
в документації: | ||
|
||
--- | ||
|
||
Подія: 'wake-up' | ||
|
||
Повердає: | ||
|
||
* `time` Текст | ||
|
||
--- | ||
|
||
The event is a string that is used after a `.on` listener method. If it returns | ||
a value it and its type is noted below. If you were to listen and respond to | ||
this event it might look something like this: | ||
|
||
```javascript | ||
Alarm.on('wake-up', function(time) { | ||
console.log(time) | ||
}) | ||
``` |