Merge pull request #209 from joce/colourize-markdown-code

kgdev · web-flow · commit bfb954adc159 · 2019-05-23T10:06:38.000+08:00
Mark relevant code blocks as `csharp` for colourization`
diff --git a/README-ZH.md b/README-ZH.md
@@ -48,7 +48,7 @@ UIWidgets主要来自[Flutter](https://github.com/flutter/flutter)。但UIWidget
 将下载的包文件夹移动到Unity项目的Package文件夹中。
 
 通常，你可以在控制台（或终端）应用程序中输入下面的代码来完成这个操作：
-    
+
    ```none
     cd <YourProjectPath>/Packages
     git clone https://github.com/UnityTech/UIWidgets.git com.unity.uiwidgets
@@ -78,7 +78,7 @@ UI Canvas。
 UIWidgets应用是用**C＃脚本**来编写的。 请按照以下步骤创建应用程序并在Unity编辑器中播放。
 1. 创建一个新C＃脚本，命名为“UIWidgetsExample.cs”，并将以下代码粘贴到其中。
 
-```none
+```csharp
     using System.Collections.Generic;
     using Unity.UIWidgets.animation;
     using Unity.UIWidgets.engine;
@@ -89,24 +89,24 @@ UIWidgets应用是用**C＃脚本**来编写的。 请按照以下步骤创建
     using Unity.UIWidgets.widgets;
     using UnityEngine;
     using FontStyle = Unity.UIWidgets.ui.FontStyle;
-    
+
     namespace UIWidgetsSample {
         public class UIWidgetsExample : UIWidgetsPanel {
             protected override void OnEnable() {
-                // if you want to use your own font or font icons.   
+                // if you want to use your own font or font icons.
                 // FontManager.instance.addFont(Resources.Load<Font>(path: "path to your font"), "font family name");
-    
-                // load custom font with weight & style. The font weight & style corresponds to fontWeight, fontStyle of 
+
+                // load custom font with weight & style. The font weight & style corresponds to fontWeight, fontStyle of
                 // a TextStyle object
-                // FontManager.instance.addFont(Resources.Load<Font>(path: "path to your font"), "Roboto", FontWeight.w500, 
+                // FontManager.instance.addFont(Resources.Load<Font>(path: "path to your font"), "Roboto", FontWeight.w500,
                 //    FontStyle.italic);
-    
+
                 // add material icons, familyName must be "Material Icons"
                 // FontManager.instance.addFont(Resources.Load<Font>(path: "path to material icons"), "Material Icons");
 
                 base.OnEnable();
             }
-    
+
             protected override Widget createWidget() {
                 return new WidgetsApp(
                     home: new ExampleApp(),
@@ -118,19 +118,19 @@ UIWidgets应用是用**C＃脚本**来编写的。 请按照以下步骤创建
                         )
                 );
             }
-    
+
             class ExampleApp : StatefulWidget {
                 public ExampleApp(Key key = null) : base(key) {
                 }
-    
+
                 public override State createState() {
                     return new ExampleState();
                 }
             }
-    
+
             class ExampleState : State<ExampleApp> {
                 int counter = 0;
-    
+
                 public override Widget build(BuildContext context) {
                     return new Column(
                         children: new List<Widget> {
@@ -193,7 +193,7 @@ UIWidgets也支持Gif！
 如果您因为任何原因需要完全禁止此插件的功能，请按上述方法禁用此插件的所有版本。
 
 此插件覆盖了Unity WebGL构建模块中的如下参数：
-```
+```none
 JS_SystemInfo_GetWidth
 JS_SystemInfo_GetHeight
 JS_SystemInfo_GetCurrentCanvasWidth
@@ -214,7 +214,7 @@ $JSEvents
 ## 调试UIWidgets应用程序
 
 #### 定义UIWidgets_DEBUG
-我们建议在Unity编辑器中定义 UIWidgets_DEBUG 脚本符号，这将打开UIWidgets中的调试断言（debug assertion），有助于更早发现潜在的Bug。 
+我们建议在Unity编辑器中定义 UIWidgets_DEBUG 脚本符号，这将打开UIWidgets中的调试断言（debug assertion），有助于更早发现潜在的Bug。
 因此选择 **Player Settings** > **Other Settings** > **Configuration** > **Scripting Define Symbols** ，并添加 UIWidgets_DEBUG。
 该符号仅供调试使用，请在发布版本中删除它。
 
@@ -238,7 +238,7 @@ UIWidgets Inspector工具用于可视化和浏览窗口小部件树。 你可以
 #### Wiki
 
 目前开发团队仍在改进UIWidgets Wiki。 由于UIWidgets主要来源于Flutter，你也可以参考Flutter Wiki中与UIWidgets API对应部分的详细描述。同时，你可以加入我们的讨论组( https://connect.unity.com/g/uiwidgets )。
- 
+
 #### 常问问题解答
 
 | 问题     | 回答  |
@@ -247,7 +247,7 @@ UIWidgets Inspector工具用于可视化和浏览窗口小部件树。 你可以
 | 我可以使用UIWidgets构建游戏UI吗？   | 可以    |
 | 我可以使用UIWidgets开发Unity编辑器插件吗？ | 可以 |
 | UIWidgets是UGUI / NGUI的扩展吗？ | 不是 |
-| UIWidgets只是Flutter的副本吗？ | 不是 | 
+| UIWidgets只是Flutter的副本吗？ | 不是 |
 | 我可以通过简单的拖放操作来创建带有UIWidgets的UI吗？ | 不可以 |
 | 我是否需要付费使用UIWidgets？ | 不需要 |
 | 有推荐的适用于UIWidgets的IDE吗？ | Rider, VSCode(Open .sln) |
diff --git a/README.md b/README.md
@@ -4,11 +4,11 @@
 
 ## Introduction
 
-UIWidgets is a plugin package for Unity Editor which helps developers to create, debug and deploy efficient, 
-cross-platform Apps using the Unity Engine. 
+UIWidgets is a plugin package for Unity Editor which helps developers to create, debug and deploy efficient,
+cross-platform Apps using the Unity Engine.
 
 UIWidgets is mainly derived from [Flutter](https://github.com/flutter/flutter). However, taking advantage of
-the powerful Unity Engine, it offers developers many new features to improve their Apps 
+the powerful Unity Engine, it offers developers many new features to improve their Apps
 as well as the develop workflow significantly.
 
 
@@ -17,7 +17,7 @@ Using the latest Unity rendering SDKs, a UIWidgets App can run very fast and kee
 
 
 #### Cross-Platform
-A UIWidgets App can be deployed on all kinds of platforms including PCs, mobile devices and web page directly, like 
+A UIWidgets App can be deployed on all kinds of platforms including PCs, mobile devices and web page directly, like
 any other Unity projects.
 
 #### Multimedia Support
@@ -54,11 +54,11 @@ Install **Unity 2018.3** or above. You can download the latest Unity on https://
 #### UIWidgets Package
 Visit our Github repository https://github.com/UnityTech/UIWidgets
  to download the latest UIWidgets package.
- 
+
 Move the downloaded package folder into the **Package** folder of your Unity project.
 
 Generally, you can make it using a console (or terminal) application by just a few commands as below:
-    
+
    ```none
     cd <YourProjectPath>/Packages
     git clone https://github.com/UnityTech/UIWidgets.git com.unity.uiwidgets
@@ -67,10 +67,10 @@ Generally, you can make it using a console (or terminal) application by just a f
 ## Getting Start
 
 #### i. Overview
-In this tutorial, we will create a very simple UIWidgets App as the kick-starter. The app contains 
+In this tutorial, we will create a very simple UIWidgets App as the kick-starter. The app contains
 only a text label and a button. The text label will count the times of clicks upon the button.
 
-First of all, please open or create a Unity Project and open it with Unity Editor. 
+First of all, please open or create a Unity Project and open it with Unity Editor.
 
 And then open Project Settings, go to Player section and **add "UIWidgets_DEBUG" to the Scripting Define Symbols field.**
 This enables the debug mode of UIWidgets for your development. Remove this for your release build afterwards.
@@ -80,15 +80,15 @@ A UIWidgets App is usually built upon a Unity UI Canvas. Please follow the steps
 UI Canvas in Unity.
 1. Create a new Scene by "File -> New Scene";
 1. Create a UI Canvas in the scene by "GameObject -> UI -> Canvas";
-1. Add a Panel (i.e., **Panel 1**) to the UI Canvas by right click on the Canvas and select "UI -> Panel". Then remove the 
+1. Add a Panel (i.e., **Panel 1**) to the UI Canvas by right click on the Canvas and select "UI -> Panel". Then remove the
 **Image** Component from the Panel.
 
 #### iii. Create Widget
 A UIWidgets App is written in **C# Scripts**. Please follow the steps to create an App and play it
 in Unity Editor.
 
 1. Create a new C# Script named "UIWidgetsExample.cs" and paste the following codes into it.
-   ```none
+   ```csharp
     using System.Collections.Generic;
     using Unity.UIWidgets.animation;
     using Unity.UIWidgets.engine;
@@ -99,24 +99,24 @@ in Unity Editor.
     using Unity.UIWidgets.widgets;
     using UnityEngine;
     using FontStyle = Unity.UIWidgets.ui.FontStyle;
-    
+
     namespace UIWidgetsSample {
         public class UIWidgetsExample : UIWidgetsPanel {
             protected override void OnEnable() {
-                // if you want to use your own font or font icons.   
+                // if you want to use your own font or font icons.
                 // FontManager.instance.addFont(Resources.Load<Font>(path: "path to your font"), "font family name");
-    
-                // load custom font with weight & style. The font weight & style corresponds to fontWeight, fontStyle of 
+
+                // load custom font with weight & style. The font weight & style corresponds to fontWeight, fontStyle of
                 // a TextStyle object
-                // FontManager.instance.addFont(Resources.Load<Font>(path: "path to your font"), "Roboto", FontWeight.w500, 
+                // FontManager.instance.addFont(Resources.Load<Font>(path: "path to your font"), "Roboto", FontWeight.w500,
                 //    FontStyle.italic);
-    
+
                 // add material icons, familyName must be "Material Icons"
                 // FontManager.instance.addFont(Resources.Load<Font>(path: "path to material icons"), "Material Icons");
-                
+
                 base.OnEnable();
             }
-    
+
             protected override Widget createWidget() {
                 return new WidgetsApp(
                     home: new ExampleApp(),
@@ -128,19 +128,19 @@ in Unity Editor.
                         )
                 );
             }
-    
+
             class ExampleApp : StatefulWidget {
                 public ExampleApp(Key key = null) : base(key) {
                 }
-    
+
                 public override State createState() {
                     return new ExampleState();
                 }
             }
-    
+
             class ExampleState : State<ExampleApp> {
                 int counter = 0;
-    
+
                 public override Widget build(BuildContext context) {
                     return new Column(
                         children: new List<Widget> {
@@ -165,14 +165,14 @@ in Unity Editor.
         }
     }
    ```
-   
+
 1. Save this script and attach it to **Panel 1** as its component.
 1. Press the "Play" Button to start the App in Unity Editor.
 
 #### iv. Build App
 Finally, the UIWidgets App can be built to packages for any specific platform by the following steps.
 1. Open the Build Settings Panel by "File -> Build Settings..."
-1. Choose a target platform and click "Build". Then the Unity Editor will automatically assemble 
+1. Choose a target platform and click "Build". Then the Unity Editor will automatically assemble
 all relevant resources and generate the final App package.
 
 #### How to load images?
@@ -186,34 +186,34 @@ UIWidgets supports Gif as well!
 3. Use Image.asset("loading1.gif") to load the gif images.
 
 #### Using Window Scope
-If you see the error ```AssertionError: Window.instance is null``` or null pointer error of ```Window.instance```,
+If you see the error `AssertionError: Window.instance is null` or null pointer error of `Window.instance`,
 it means the code is not running in the window scope. In this case, you can enclose your code
 with window scope as below:
-```
+```csharp
 using(WindowProvider.of(your gameObject with UIWidgetsPanel).getScope()) {
-    // code dealing with UIWidgets, 
+    // code dealing with UIWidgets,
     // e.g. setState(() => {....})
 }
 ```
 
 This is needed if the code is in methods
-not invoked by UIWidgets. For example, if the code is in ```completed``` callback of ```UnityWebRequest```, 
-you need to enclose them with window scope. 
+not invoked by UIWidgets. For example, if the code is in `completed` callback of `UnityWebRequest`,
+you need to enclose them with window scope.
 Please see [HttpRequestSample](./Samples/UIWidgetSample/HttpRequestSample.cs) for detail.
-For callback/event handler methods from UIWidgets (e.g ```Widget.build, State.initState...```), you don't need do
+For callback/event handler methods from UIWidgets (e.g `Widget.build, State.initState...`), you don't need do
 it yourself, since the framework ensure it's in window scope.
 
 #### Show Status Bar on Android
 Status bar is always hidden by default when an Unity project is running on an Android device. If you
  want to show the status bar in your App, this
- [solution](https://github.com/Over17/UnityShowAndroidStatusBar) seems to be 
+ [solution](https://github.com/Over17/UnityShowAndroidStatusBar) seems to be
  compatible to UIWidgets, therefore can be used as a good option before we release our
- full support solution on this issue. 
- 
+ full support solution on this issue.
+
  Besides,
  please set "Render Outside Safe Area" to true in the "Player Settings" to make this plugin working properly on Android P or later.
- 
- 
+
+
 
 
 #### Automatically Adjust Frame Rate
@@ -230,15 +230,15 @@ Please select the plugin of the Unity version corresponding to your project, and
 If you need to disable this plugin for any reason, please disable all the versions of this plugin as described above.
 
 This plugin overrides the following parameters in the Unity WebGL building module:
-```
+```none
 JS_SystemInfo_GetWidth
 JS_SystemInfo_GetHeight
 JS_SystemInfo_GetCurrentCanvasWidth
 JS_SystemInfo_GetCurrentCanvasHeight
 $Browser
 $JSEvents
 ```
-If you would like to implement your own WebGL plugin, and your plugin overrides at least one of the above parameters, you need to disable the `UIWidgetsCanvasDevicePixelRatio` plugin in the above mentioned way to avoid possible conflicts. 
+If you would like to implement your own WebGL plugin, and your plugin overrides at least one of the above parameters, you need to disable the `UIWidgetsCanvasDevicePixelRatio` plugin in the above mentioned way to avoid possible conflicts.
 If you still need the function provided by this plugin, you can mannually apply the modification to Unity WebGL building module introduced in this plugin.
 All the modifications introduced in `UIWidgetsCanvasDevicePixelRatio` are marked by `////////// Modifcation Start ////////////` and `////////// Modifcation End ////////////`.
 In the marked codes, all the multiplications and divisions with `devicePixelRatio` are introduced by our modification.
@@ -247,37 +247,37 @@ To learn about the original script in detail, please refer to `SystemInfo.js` an
 #### Image Import Setting
 Unity, by default, resizes the width and height of an imported image to the nearest integer that is a power of 2.
 In UIWidgets, you should almost always disable this by selecting the image in the "Project" panel, then in the "Inspector" panel set the "Non Power of 2" option (in "Advanced") to "None", to prevent your image from being resized unexpectedly.
- 
+
 ## Debug UIWidgets Application
 
 #### Define UIWidgets_DEBUG
-It's recommended to define the **UIWidgets_DEBUG** script symbol in editor, this will turn on 
+It's recommended to define the **UIWidgets_DEBUG** script symbol in editor, this will turn on
 debug assertion in UIWidgets, which will help to find potential bugs earlier. To do this:
-please go to **Player Settings -> Other Settings -> Configuration -> Scripting Define Symbols**, 
-and add **UIWidgets_DEBUG**.  
+please go to **Player Settings -> Other Settings -> Configuration -> Scripting Define Symbols**,
+and add **UIWidgets_DEBUG**.
 The symbol is for debug purpose, please remove it from your release build.
 
 #### UIWidgets Inspector
 The UIWidgets Inspector tool is for visualizing and exploring the widget trees. You can find it
-via *Window/Analysis/UIWidgets* inspector in Editor menu.  
+via *Window/Analysis/UIWidgets* inspector in Editor menu.
 **Note**
-* **UIWidgets_DEBUG** needs to be define for inspector to work properly.  
+* **UIWidgets_DEBUG** needs to be define for inspector to work properly.
 * Inspector currently only works in Editor Play Mode, inspect standalone built application is not supported for now.
 
 ## Learn
 
 #### Samples
-You can find many UIWidgets App samples in the UIWidgets package in the **Samples** folder. 
+You can find many UIWidgets App samples in the UIWidgets package in the **Samples** folder.
 Feel free to try them out and make modifications to see the results.
 To get started, the UIWidgetsTheatre scene provides you
 a list of carefully selected samples to start with.
 
-You can also try UIWidgets-based Editor windows by clicking **UIWidgetsTest** on the main menu 
+You can also try UIWidgets-based Editor windows by clicking **UIWidgetsTest** on the main menu
 and open one of the dropdown samples.
 
 #### Wiki
 The develop team is still working on the UIWidgets Wiki. However, since UIWidgets is mainly derived from Flutter,
- you can refer to Flutter Wiki to access detailed descriptions of UIWidgets APIs 
+ you can refer to Flutter Wiki to access detailed descriptions of UIWidgets APIs
  from those of their Flutter counterparts.
 Meanwhile, you can join the discussion channel at (https://connect.unity.com/g/uiwidgets)
 
@@ -289,7 +289,7 @@ Meanwhile, you can join the discussion channel at (https://connect.unity.com/g/u
 | Can I use UIWidgets to build game UIs?   | **Yes**    |
 | Can I develop Unity Editor plugins using UIWidgets?  | **Yes** |
 | Is UIWidgets a extension of UGUI/NGUI? | **No** |
-| Is UIWidgets just a copy of Flutter? | **No** | 
+| Is UIWidgets just a copy of Flutter? | **No** |
 | Can I create UI with UIWidgets by simply drag&drop? | **No** |
 | Do I have to pay for using UIWidgets? | **No** |
 | Any IDE recommendation for UIWidgets? | **Rider, VSCode(Open .sln)** |
