This page contains information about the macros available with the app and
...
the parameters available in each.
Page contents
| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview of the macros
Macro name | How does it look? (The images shown here are mainly from the cloud version and are similar in the server version.) | Description |
|---|---|---|
Github Issue List Macro |  | Displays a list of issues from a specified repository. |
Github Pull Request List Macro |  | Displays a list of pull requests from a specified repository based on a query, if given. |
Github Markdown Macro |  | Displays the contents of a Markdown file located in a specific repository. |
Github File |
...
Macro |  | Displays the contents of a file located in a specific repository. |
Parameters
This section lists the parameters
...
available in the macros. Unless there are any differences between the server and cloud versions, the mentioned parameters are common to both.
Common parameters
All these parameters are mandatory.
Parameter name |
|---|
...
Common to which macros?
Description | |
|---|---|
Github Token | Select the token to be used from the dropdown list. Contact your administrator if an error occurs or if you are unable to connect to the repository. For more information, see more in the Configuration page for server and/or cloud. |
User | Enter the user name required to access the relevant repository. In Github Markdown Macro (cloud), this parameter is available on the Enter Repository Settings tab labelled as Username/Organization Username. |
Repository | Enter the repository name to be accessed. |
Query | Enter a query to access the required pull requests or issues. Use the Github's Query language to choose the pull requests or issues that you wish to display. This parameter is available only in the Github Issues List Macro and Github Pull Request List Macro in both, server and cloud, versions. |
Other parameters
The following parameters are available to specific macros:
Parameter name | Available in which macros? | Description |
|---|---|---|
URL | Github Markdown Macro (cloud) | Enter the URL of the Markdown file to be accessed. Click the Check button to verify the file path. |
Branch or Commit Hash | Github Markdown Macro (both versions; in cloud, under Enter Repository Settings tab) Github File Mmacro (both versions) | Enter the branch or commit code to be accessed. Examples: |
File Path | Github Markdown Macro (both versions; in cloud, under Enter Repository Settings tab) Github File Macro (both versions) | Enter the actual path of the Markdown file to be displayed. |
Hide line numbers of code block (server) Hide line numbers (cloud) | Github File Macro (both versions) | Enable this option to hide line numbers of the code block from being displayed. |
Lines of code | Github File Macro (both versions) | Enter a line number or a range of lines to be displayed through the macro. Example: |