{"action":"opened","issue":{"url":"https://api.github.com/repos/dji-sdk/Mobile-SDK-Tutorial/issues/19","labels_url":"https://api.github.com/repos/dji-sdk/Mobile-SDK-Tutorial/issues/19/labels{/name}","comments_url":"https://api.github.com/repos/dji-sdk/Mobile-SDK-Tutorial/issues/19/comments","events_url":"https://api.github.com/repos/dji-sdk/Mobile-SDK-Tutorial/issues/19/events","html_url":"https://github.com/dji-sdk/Mobile-SDK-Tutorial/issues/19","id":105033342,"number":19,"title":"DJI SDK Markdown Document Update Guide","user":{"login":"oliverou","id":13310805,"avatar_url":"https://avatars.githubusercontent.com/u/13310805?v=3","gravatar_id":"","url":"https://api.github.com/users/oliverou","html_url":"https://github.com/oliverou","followers_url":"https://api.github.com/users/oliverou/followers","following_url":"https://api.github.com/users/oliverou/following{/other_user}","gists_url":"https://api.github.com/users/oliverou/gists{/gist_id}","starred_url":"https://api.github.com/users/oliverou/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/oliverou/subscriptions","organizations_url":"https://api.github.com/users/oliverou/orgs","repos_url":"https://api.github.com/users/oliverou/repos","events_url":"https://api.github.com/users/oliverou/events{/privacy}","received_events_url":"https://api.github.com/users/oliverou/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":0,"created_at":"2015-09-05T15:37:08Z","updated_at":"2015-09-05T15:37:08Z","closed_at":null,"body":"## Suggested workflow of updating document\r\n\r\nThe official update will be handled by DJI SDK staffs. Developers are welcome to fix any bug/issue by sending pull request.\r\n\r\nWhen an issue/bug/mistake is found in our document. The developer can create and send a pull request to fix it. \r\n\r\nHe/She **must** refer the pull request of a related discussion, forum.dji.com or bbs.dji.com or github issue or email records, where a SDK staff **must** admit it as a problem in our document.\r\n\r\nThe pull request which does not follow the guild line will not be accepted.\r\n\r\n## Suggested format of Markdown document\r\n\r\nThis part talks about the document format and syntax. You can refer to [Github's Mastering Markdown Guides](https://guides.github.com/features/mastering-markdown/) as an example or reference.\r\n\r\n### 1. Suggested usage of `#`\r\n\r\nIn a markdown document, we use the `#` symbol in headers to structured document. It's useful to have different levels of headings to structure your document. Multiple `##` in a row can make smaller heading sizes. Here is the suggested usage example:\r\n\r\n- **code**\r\n\r\n\t\t# Document Title\r\n\t\t## Main Topic Title 1\r\n\t\t### 1. SubTopic Title\r\n\t\t## Main Topic Title 2\r\n\t\t### 1. SubTopic Title 1\r\n\t    ### 2. SubTopic Title 2\r\n\r\n- **result**\r\n\r\n># Document Title\r\n>## Main Topic Title 1\r\n>### 1. SubTopic Title\r\n>## Main Topic Title 2\r\n>### 1. SubTopic Title 1\r\n>### 2. SubTopic Title 2\r\n\t\r\nPlease don't use it like this way:\r\n\r\n- **code**\r\n\r\n\t\t## Document Title\r\n\t\t### Main Topic Title 1\r\n\t\t#### 1. SubTopic Title\r\n\t\t## Main Topic Title 2\r\n\t\t##### 1. SubTopic Title 1\r\n\t    ##### 2. SubTopic Title 2\r\n\t    \r\n- **result**\r\n\r\n>## Document Title\r\n>### Main Topic Title 1\r\n>#### 1. SubTopic Title\r\n>## Main Topic Title 2\r\n>##### 1. SubTopic Title 1\r\n>##### 2. SubTopic Title 2\r\n    \r\n Make sure you use `#` in a proper way, it will make your document's structure looks better and easy to read.\r\n\r\n### 2. Tables\r\n\r\nYou can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:\r\n\r\nHere is a table example:\r\n\r\nFirst Header  | Second Header\r\n------------- | -------------\r\nContent Cell  | Content Cell\r\nContent Cell  | Content Cell\r\n\r\nYou can align cell contents with syntax like this:\r\n\r\n| Left Aligned |  Center Aligned  | Right Aligned |\r\n|:-------------|:----------------:| -------------:|\r\n|Request Data|1~100|User defined data|\r\n|Return Data|2|Return code 0: success|\r\n\r\nThe left and right most pipes (`|`) are only aesthetic, and can be omitted. The spaces don’t matter, either. Alignment depends on the `:` marks.\r\n\r\n### 3. Images\r\n\r\n  All images should be stored in the `Images` folder and developers should refer to the image using **relative path** instead of absolute path.\r\n\r\n  For example, you should use `![N1UI](Images/N1UI.png)` instead of `![N1UI](https://github.com/dji-sdk/Onboard-SDK/blob/master/Onboard_API_Doc/en/Images/N1UI.png)`\r\n\r\n### 4. Codes\r\n\r\n  If you have inline code blocks, please wrap them in backticks: `var example = true`.\r\n  \r\n  If you want to insert multiple lines of code, we suggest to use **Fenced Code Block**. You can use waves (`~`) and back ticks (`` ` ``) between code.\r\n\r\n - Code:\r\n\r\n\t\t~~~\r\n\t\tvoid get_control_callback(const void* p_data, unsigned int n_size) { }\r\n\t\t~~~\r\n\r\n - Result: \r\n   \r\n~~~\r\nvoid get_control_callback(const void* p_data, unsigned int n_size) { }\r\n~~~\r\n\r\n  Lastly, if you'd like to use syntax highlighting, include the language:\r\n  \r\n - Code:\r\n\r\n\t\t~~~c\r\n\t\tvoid get_control_callback(const void* p_data, unsigned int n_size) { }\r\n\t\t~~~\r\n\r\n - Result: \r\n   \r\n~~~c\r\nvoid get_control_callback(const void* p_data, unsigned int n_size) { }\r\n~~~\r\n"}}