Providing code editor documentation pages using a lightweight text formatting language and platform-agnostic command links
Providing code editor documentation pages using a lightweight text formatting language and platform-agnostic command links is disclosed. A code editor may provide a documentation code editor extension that enables developers to provide documentation pages that are defined using a lightweight text formatting language, and that include platform-agnostic command links. When selected by a user, the platform-agnostic command links are parsed by the documentation code editor extension, which then initiates execution of a corresponding command using an application programming interface (API) of the code editor. The platform-agnostic command link may comprise a scheme identifier and one or more attribute-value pairs used to specify a command, a project file path, a source file path, an extension file path, a completion message, an error message, a command text input, and/or a user-provided text input. In this manner, interactive documentation pages may provide command links across multiple platforms.
1. A method for providing code editor documentation pages using a lightweight text formatting language and platform-agnostic command links, comprising:
rendering, using a display device coupled to a computing device comprising a processor device, a documentation page for a code editor or a code editor extension as Hypertext Markup Language (HTML) within a code editor interface of the code editor, wherein the documentation page is defined using a lightweight text formatting language and includes one or more platform-agnostic command links each of the platform-agnostic command links corresponding to a command of one or more commands of the code editor or the code editor extension;
receiving, via a user input device by a documentation code editor extension executing on the processor device, a selection of a platform-agnostic command link of the one or more platform-agnostic command links; and
responsive to receiving the selection of the platform-agnostic command link:
parsing, by the documentation code editor extension, the platform-agnostic command link to identify a corresponding command; and
initiating, by the documentation code editor extension, execution of the corresponding command via an application programming interface (API) of the code editor.
2. The method of claim 1 , wherein each of the one or more platform-agnostic command links comprises a scheme identifier and one or more attribute-value pairs.
3. The method of claim 2 , wherein the one or more attribute-value pairs specifies one or more of a command, a project file path, a source file path, an extension file path, a completion message, an error message, a command text input, and a user-provided text input.
4. The method of claim 1 , wherein:
the code editor comprises Microsoft Visual Studio (VS) Code;
the API comprises a VS Code API; and
the corresponding command comprises a VS Code command.
5. The method of claim 1 , wherein receiving the selection of the platform-agnostic command link comprises receiving the selection of the platform-agnostic command link using a custom click event handler.
6. The method of claim 1 , wherein the lightweight text formatting language comprises one of Markdown and AsciiDoc.
7. The method of claim 1 , further comprising displaying, using the display device, a user feedback message upon completion of the execution of the corresponding command.
8. A computing device, comprising:
a memory; and
a processor device coupled to the memory to:
render, using a display device, a documentation page for a code editor or a code editor extension as Hypertext Markup Language (HTML) within a code editor interface of the code editor, wherein the documentation page is defined using a lightweight text formatting language and includes one or more platform-agnostic command links each of the platform-agnostic command links corresponding to a command of one or more commands of the code editor or the code editor extension;
receive, via a user input device using a documentation code editor extension, a selection of a platform-agnostic command link of the one or more platform-agnostic command links; and
responsive to receiving the selection of the platform-agnostic command link:
parse, using the documentation code editor extension, the platform-agnostic command link to identify a corresponding command; and
initiate, using the documentation code editor extension, execution of the corresponding command via an application programming interface (API) of the code editor.
9. The computing device of claim 8 , wherein each of the one or more platform-agnostic command links comprises a scheme identifier and one or more attribute-value pairs.
10. The computing device of claim 9 , wherein the one or more attribute-value pairs specifies one or more of a command, a project file path, a source file path, an extension file path, a completion message, an error message, a command text input, and a user-provided text input.
11. The computing device of claim 8 , wherein:
the code editor comprises Microsoft Visual Studio (VS) Code;
the API comprises a VS Code API; and
the corresponding command comprises a VS Code command.
12. The computing device of claim 8 , wherein to receive the selection of the platform-agnostic command link is to receive the selection of the platform-agnostic command link using a custom click event handler.
13. The computing device of claim 8 , wherein the lightweight text formatting language comprises one of Markdown and AsciiDoc.
14. The computing device of claim 8 , wherein the processor device is further to display, using the display device, a user feedback message upon completion of the execution of the corresponding command.
15. A computer program product stored on a non-transitory computer-readable storage medium and including instructions to cause a processor device to:
render, using a display device, a documentation page of a code editor or a code editor extension as Hypertext Markup Language (HTML) within a code editor interface of a code editor, wherein the documentation page is defined using a lightweight text formatting language and includes one or more platform-agnostic command links each of the platform-agnostic command links corresponding to a command of one or more commands of the code editor or the code editor extension;
receive, via a user input device using a documentation code editor extension, a selection of a platform-agnostic command link of the one or more platform-agnostic command links; and
responsive to receiving the selection of the platform-agnostic command link:
parse, using the documentation code editor extension, the platform-agnostic command link to identify a corresponding command; and
initiate, using the documentation code editor extension, execution of the corresponding command via an application programming interface (API) of the code editor.
16. The computer program product of claim 15 , wherein each of the one or more platform-agnostic command links comprises a scheme identifier and one or more attribute-value pairs.
17. The computer program product of claim 16 , wherein the one or more attribute-value pairs specifies one or more of a command, a project file path, a source file path, an extension file path, a completion message, an error message, a command text input, and a user-provided text input.
18. The computer program product of claim 15 , wherein:
the code editor comprises Microsoft Visual Studio (VS) Code;
the API comprises a VS Code API; and
the corresponding command comprises a VS Code command.
19. The computer program product of claim 15 , wherein to receive the selection of the platform-agnostic command link is to receive the selection of the platform-agnostic command link using a custom click event handler.
20. The computer program product of claim 15 , wherein the lightweight text formatting language comprises one of Markdown and AsciiDoc.