https://github.com/patridge/learn-module-creator
A Visual Studio Code extension for creating the initial structure for your new Microsoft Learn modules.
https://github.com/patridge/learn-module-creator
Last synced: 3 months ago
JSON representation
A Visual Studio Code extension for creating the initial structure for your new Microsoft Learn modules.
- Host: GitHub
- URL: https://github.com/patridge/learn-module-creator
- Owner: patridge
- License: mit
- Created: 2018-10-02T19:31:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-06T16:38:09.000Z (about 6 years ago)
- Last Synced: 2025-01-01T10:25:01.669Z (5 months ago)
- Language: TypeScript
- Size: 46.9 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Microsoft Learn module creator
A Visual Studio Code extension for creating the initial structure for your new Microsoft Learn modules.
## Install the Generator
From the Extensions side bar in Visual Studio Code, find the **Microsoft Learn module creator** (id: learn-module-creator) extension and install it. Reload VS Code when it completes.
## Run yo generator-learn-module
The Microsoft Learn module creator will walk you through the steps required to create your module, prompting for values used to generate the initial structure.
To start creating a module, run the **Generate a Microsoft Learn module** command from the command palette (**Cmd**+**Shift**+**P**).
## Generator Output
This extension will create a base folder structure of YAML and Markdown content, with the `{your-module-id}` value derived from the module title you provide.
* ./{your-module-id}/
* index.yml
* 1-introduction.yml
* 6-summary.yml
* /includes/
* 1-introduction.md
* 6-summary.md
While you will want a module summary, do not feel obliged to keep it as the sixth unit in your module. Just remember to renumber the YAML and Markdown files as well as the ID in the index.yml and the 6-summary.yml files, if you do.
## History
* 0.2.0: Fixed [event-stream vulnerability](https://code.visualstudio.com/blogs/2018/11/26/event-stream), and updated any npm packages as a result.
* 0.1.0: Generates the basic scaffolding for a new Microsoft Learn module.
## License
[MIT](https://github.com/patridge/learn-module-creator/blob/master/LICENSE)