Docs Article Templates Extension

The Docs Article Templates extension lets writers in VS Code pull a Markdown template from a centralized store and apply it to a file. Templates can help ensure that required metadata is included in articles, that content standards are followed, and so on. Templates are managed as Markdown files in a public GitHub repository.

For the first release of the Docs Article Templates extension, only simple Markdown files are supported. All template content, including file metadata, must be in each file, and all templates will be available to all users of the extension. More advanced functionality, such as shared metadata files, conditional text fields, and repo-specific templates, are planned for later releases.

To apply a template in VS Code

1. Ensure the Docs Article Templates extension is installed and enabled.
2. If you don't have the Docs Markdown extension installed, hit F1 to open the command palette, start typing "template" to filter, then click Docs: Template. If you do have Docs Markdown installed, you can use either the command palette or click Alt+M to bring up the Docs Markdown QuickPick menu, then select Template from the list.
3. Select the desired template from the list that appears.

To create a Learn module in VS Code

1. In VSC open to the root working folder of your repository containing the achievements, path, and "product" folders.
2. If you don't have the Docs Markdown extension installed, hit F1 to open the command palette, start typing "template" to filter, then click Docs: Template. If you do have Docs Markdown installed, you can use either the command palette or click Alt+M to bring up the Docs Markdown QuickPick menu, then select Template from the list.
3. From the drop-down list of templates select Learn module.
4. When prompted select the module's parent folder.
5. In the "Enter module name" prompt enter your module's name. This is used to create the module, media, and include folders, the index.yml, and the module uid. Example: Module with the friendly name What is m365 will automatically be formatted as what-is-m365 by the template extension for the applicable fields.
6. In the "Enter unit name" prompt enter the first unit name. This will be used to create the unit yml and content .md file with the same name, for example introduction.
7. Answer Yes to the message dialog for your next unit name.
8. Repeat steps 7 and 8 for each new unit yml you need to create. Once all units have been created,select No to exit.

To add units to an existing Learn module in VS Code

1. In VSC open to the root working folder of your repository containing the achievements, path, and "product" folders.
2. Open a module topic (index.yml).
3. If you don't have the Docs Markdown extension installed, hit F1 to open the command palette, start typing "template" to filter, then click Docs: Template. If you do have Docs Markdown installed, you can use either the command palette or click Alt+M to bring up the Docs Markdown QuickPick menu, then select Template from the list.
4. From the drop-down list of templates select Add unit to active module.
5. In the "Enter unit name" prompt enter the first unit name. This will be used to create the unit yml and content .md file with the same name, for example introduction.
6. Answer Yes to the message dialog for your next unit name.
7. Repeat steps 6 and 7 for each new unit yml you need to create. Once all units have been created,select No to exit.