You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- .NET library `Markdown.MAML.dll` written in C#. It does heavy lifting, like parsing markdown, transforming it into xml and so on.
12
-
You can open `.\Markdown.MAML.sln` in Visual Studio 2015.
13
-
- PowerShell scripts in `.\src\platyPS`. They provide user interface.
11
+
-`Markdown.MAML.dll`, a .NET library written in C#.
12
+
It does the heavy lifting, like parsing Markdown, transforming it into XML, and so on.
13
+
You can open `.\Markdown.MAML.sln` in Visual Studio 2015.
14
+
- A PowerShell module in `.\src\platyPS`.
15
+
This module provides the user CLI.
14
16
15
17
## First-time setup
16
18
17
-
Restore nuget packages.
18
-
You can do it from visual studio, or from command line
19
+
Restore NuGet packages.
20
+
You can do this from Visual Studio, or from the command line.
19
21
20
22
```
21
23
.\.nuget\NuGet.exe restore
22
24
```
23
25
24
26
## Build
25
27
26
-
To build the whole project, use helper`build.ps1` script
28
+
To build the whole project, use the`build.ps1`helper script.
27
29
28
30
```
29
31
.\build.ps1
30
32
```
31
-
As part of build, module generate help for itself.
32
-
The result of the build would be in `out\platyPS` folder.
33
+
As part of the build, platyPS generates help for itself.
34
+
The output of the build is placed in `out\platyPS`.
33
35
34
-
`build.ps1` also imports the module from `out\platyPS` and generates help for the tool itself.
36
+
`build.ps1` also imports the module from `out\platyPS` and generates help itself.
35
37
36
-
**Note**: if you changed C# code, script will try to overwrite a dll in-use.
37
-
You would need to re-open your powershell session. If you know a better workflow, please suggest it in the issues.
38
+
**Note**: if you changed C# code, `build.ps1` will try to overwrite a DLL in use.
39
+
You will then need to re-open your PowerShell session.
40
+
If you know a better workflow, please suggest it in the Issues.
38
41
39
42
## Tests
40
43
41
-
There are two part of projects and two test sets.
44
+
Each part of the project has a test set:
42
45
43
-
- C# part with xUnit tests. You can run them with XUnit runner from the visual studio.
44
-
- PowerShell part with [Pester](https://github.com/pester/Pester) tests
46
+
- The C# part has xUnit tests.
47
+
You can run them with xUnit from Visual Studio.
48
+
- The PowerShell part has [Pester](https://github.com/pester/Pester) tests.
49
+
You can run them using:
50
+
```
51
+
Invoke-Pester
52
+
```
45
53
46
-
```
47
-
Invoke-Pester
48
-
```
49
-
50
-
**Note**: Pester tests always force-import module from the output ___location of `.\build.ps1`.
54
+
**Note**: Pester tests always force-import the module from the output ___location of `.\build.ps1`.
51
55
52
56
## Schema
53
57
54
-
If you have ideas or concerns about markdown schema feel free to open a GitHub issue to discuss it.
58
+
If you have ideas or concerns about the Markdown schema, feel free to open a GitHub Issue to discuss it.
55
59
56
60
## Repo structure
57
61
@@ -64,11 +68,12 @@ If you have ideas or concerns about markdown schema feel free to open a GitHub i
64
68
## Data transformations
65
69
66
70
Data transformations are the core of platyPS.
67
-
User has content in some form and she wants to transform it into another form.
68
-
I.e. transform existing module help to markdown and use it in future to generate the external help and static html for online references.
71
+
A user has content in some form and she wants to transform it into another form.
72
+
E.g. transform existing module help (in MAML) to Markdown and use it in the future to generate the external help (MAML) and static HTML for online references.
69
73
70
-
PlatyPS PowerShell module provide APIs in the form of cmdlets for the end-user scenarios.
71
-
This scenarios are assembled from the simple transformations. Chart below describes this simple transformations.
74
+
platyPS provides APIs in the form of cmdlets for end-user scenarios.
75
+
These scenarios are assembled from simple transformations.
76
+
This chart describes these simple transformations:
72
77
73
78
```
74
79
+----------+
@@ -102,28 +107,27 @@ This scenarios are assembled from the simple transformations. Chart below descri
102
107
103
108
##### Example `New-MarkdownHelp`
104
109
105
-
User creates a platyPS markdown for the first time for the command
110
+
A user creates a platyPS Markdown for the first time with `New-MarkdownHelp`:
106
111
107
112
```
108
-
New-MarkdownHelp -command New-MyCommandHelp
113
+
New-MarkdownHelp -Command New-MyCommandHelp
109
114
```
110
115
111
-
Under the hood, following tranformations happens
116
+
Under the hood, the following tranformations happen:
0 commit comments