Browse Source

:memo: Update docs styles

* Adjust line length to `80`
* Normalize whitespaces

[ci skip]
Plusb Preco 9 years ago
parent
commit
346ef9df0c
2 changed files with 12 additions and 10 deletions
  1. 9 9
      docs/api/app.md
  2. 3 1
      docs/api/auto-updater.md

+ 9 - 9
docs/api/app.md

@@ -356,16 +356,16 @@ Clears the recent documents list.
 
 ### `app.setAsDefaultProtocolClient(protocol)` _OS X_ _Windows_
 
- * `protocol` String - The name of your protocol, without `://`. If you want your
-   app to handle `electron://` links, call this method with `electron` as the
-   parameter.
-   
+* `protocol` String - The name of your protocol, without `://`. If you want your
+  app to handle `electron://` links, call this method with `electron` as the
+  parameter.
+
 This method sets the current executable as the default handler for a protocol
 (aka URI scheme). It allows you to integrate your app deeper into the operating
 system. Once registered, all links with `your-protocol://` will be openend with
 the current executable. The whole link, including protocol, will be passed to
 your application as a parameter.
- 
+
 **Note:** On OS X, you can only register protocols that have been added to
 your app's `info.plist`, which can not be modified at runtime. You can however
 change the file with a simple text editor or script during build time.
@@ -375,11 +375,11 @@ The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally
 
 ### `app.removeAsDefaultProtocolClient(protocol)` _Windows_
 
- * `protocol` String - The name of your protocol, without `://`.
-   
+* `protocol` String - The name of your protocol, without `://`.
+
 This method checks if the current executable as the default handler for a protocol
 (aka URI scheme). If so, it will remove the app as the default handler.
- 
+
 **Note:** On OS X, removing the app will automatically remove the app as the
 default protocol handler.
 
@@ -576,4 +576,4 @@ Sets the `image` associated with this dock icon.
 [dock-menu]:https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/concepts/dockconcepts.html#//apple_ref/doc/uid/TP30000986-CH2-TPXREF103
 [tasks]:http://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#tasks
 [app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx
-[CFBundleURLTypes]: https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/TP40009249-102207-TPXREF115
+[CFBundleURLTypes]: https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/TP40009249-102207-TPXREF115

+ 3 - 1
docs/api/auto-updater.md

@@ -2,7 +2,8 @@
 
 This module provides an interface for the `Squirrel` auto-updater framework.
 
-You can quickly launch a multi-platform release server for distributing your application by forking [electron-release-server](https://github.com/ArekSredzki/electron-release-server).
+You can quickly launch a multi-platform release server for distributing your
+application by forking [electron-release-server][electron-release-server].
 
 ## Platform notices
 
@@ -101,3 +102,4 @@ should only be called after `update-downloaded` has been emitted.
 [squirrel-windows]: https://github.com/Squirrel/Squirrel.Windows
 [installer]: https://github.com/atom/grunt-electron-installer
 [app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx
+[electron-release-server]: https://github.com/ArekSredzki/electron-release-server