doc: Add titles for all pages.
authorCheng Zhao <zcbenz@gmail.com>
Mon, 9 Sep 2013 07:35:57 +0000 (15:35 +0800)
committerCheng Zhao <zcbenz@gmail.com>
Mon, 9 Sep 2013 07:35:57 +0000 (15:35 +0800)
20 files changed:
docs/app.md
docs/atom-delegate.md
docs/auto-updater.md
docs/build-instructions-mac.md
docs/build-instructions-windows.md
docs/build-native-modules.md
docs/clipboard.md
docs/coding-style.md
docs/crash-reporter.md
docs/dialog.md
docs/ipc-browser.md
docs/ipc-renderer.md
docs/menu-item.md
docs/menu.md
docs/power-monitor.md
docs/protocol.md
docs/quick-start.md
docs/remote.md
docs/shell.md
docs/source-code-directory-structure.md

index f9f075b..092eb38 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# app
 
 The `app` module is responsible for controlling the application's life time.
 
index f4cb307..b172a77 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# atom-delegate
 
 The `atom-delegate` returns the delegate object for Chrome Content API. The
 atom-shell would call methods of the delegate object when the corresponding
index 77d9127..d78a872 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# auto-updater
 
 `auto-updater` module is a simple wrap around the Sparkle framework, it
 provides auto update service for the application.
index f1d6d5d..d56876e 100644 (file)
@@ -1,3 +1,5 @@
+# Build instructions (Mac)
+
 ## Prerequisites
 
 * Mac OS X >= 10.7
index d95bf2d..3939a9f 100644 (file)
@@ -1,3 +1,5 @@
+# Build instructions (Windows)
+
 ## Prerequisites
 
 * Windows 7 or later
index 19a8c92..feb5514 100644 (file)
@@ -1,3 +1,5 @@
+# Build native modules
+
 Since atom-shell is using a different V8 version from the official node, you
 need to build native module against atom-shell's headers to use them.
 
index 3775fba..f95364f 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# clipboard
 
 An example of writing a string to clipboard:
 
index 99e4c69..28f3c5b 100644 (file)
@@ -1,3 +1,5 @@
+# Coding style
+
 ## C++ and Python
 
 For C++ and Python, we just follow Chromium's [Coding
index e5fde5c..b6785fa 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# crash-reporter
 
 An example of automatically submitting crash reporters to remote server:
 
index 2b7f58c..0ded6b4 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# dialog
 
 The `dialog` module provides functions to show system dialogs, so web
 applications can get the same user experience with native applications.
index 3006151..34ebda8 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# ipc (browser)
 
 The `ipc` module allows developers to send asynchronous messages to renderers.
 To avoid possible dead-locks, it's not allowed to send synchronous messages in
index 78533db..cdeadf3 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# ipc (renderer)
 
 The `ipc` module provides a few methods so you can send synchronous and
 asynchronous messages to the browser, and also receive messages sent from
index 693343a..ec54743 100644 (file)
@@ -1,3 +1,5 @@
+# menu-item
+
 ## Class: MenuItem
 
 ### new MenuItem(options)
index 586d544..2e813d5 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# menu
 
 The `Menu` class is used to create native menus that can be used as
 application menu and context menu. Each menu is consisted of multiple menu
index 873d2a9..1f7169f 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# power-monitor
 
 The `power-monitor` module is used to monitor the power state change, you can
 only use it on the browser side.
index d13025d..ec6c1f2 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# protocol
 
 The `protocol` module can register a new protocol or intercept an existing
 protocol, so you can custom the response to the requests for vairous protocols.
index 37a4bf3..5ba8e85 100644 (file)
@@ -1,3 +1,5 @@
+# Quick start
+
 ## Introduction
 
 Generally, atom-shell lets you create a web-based desktop application in pure
index 3514826..7411768 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# remote
 
 It's common that the developers want to use modules in browsers from the
 renderer, like closing current window, opening file dialogs, etc. Instead of
index 3cb8350..e909ac6 100644 (file)
@@ -1,4 +1,4 @@
-## Synopsis
+# shell
 
 The `shell` module provides functions related to desktop integration.
 
index 00a0d4f..3f46bf6 100644 (file)
@@ -1,3 +1,5 @@
+# Source code directory structure
+
 ## Overview
 
 The source code of atom-shell is separated into a few parts, and we are mostly
@@ -13,6 +15,7 @@ to understand the source code better.
   program.
 * **browser** - The frontend including the main window, UI, and all browser
   side things. This talks to the renderer to manage web pages.
+  * **ui** - Implementation of UI stuff for different platforms.
   * **atom** - Initializes the javascript environment of browser.
   * **default_app** - The default page to show when atom-shell is started
     without providing an app.