Skip to content

Commit 7ae8cac

Browse files
committed
build: Set docs dir for platyps and move cache into subfolder
1 parent 1574cd2 commit 7ae8cac

File tree

7 files changed

+171
-132
lines changed

7 files changed

+171
-132
lines changed
File renamed without changes.

docs-workshop/docs-workshop.psm1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ $script:api = @{
2525
}
2626
}
2727

28-
$script:dadjokes = [io.file]::ReadAllText((Resolve-Path $PSScriptRoot/jokes-cache.json)) | ConvertFrom-Json
28+
$script:dadjokes = [io.file]::ReadAllText((Resolve-Path $PSScriptRoot/cache/dadjokes.json)) | ConvertFrom-Json
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
external help file: docs-workshop-help.xml
3+
Module Name: docs-workshop
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Find-DadJoke
9+
10+
## SYNOPSIS
11+
{{ Fill in the Synopsis }}
12+
13+
## SYNTAX
14+
15+
```
16+
Find-DadJoke [[-Term] <String>] [[-Format] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
{{ Fill in the Description }}
21+
22+
## EXAMPLES
23+
24+
### Example 1
25+
```powershell
26+
PS C:\> {{ Add example code here }}
27+
```
28+
29+
{{ Add example description here }}
30+
31+
## PARAMETERS
32+
33+
### -Format
34+
{{ Fill Format Description }}
35+
36+
```yaml
37+
Type: String
38+
Parameter Sets: (All)
39+
Aliases:
40+
Accepted values: json, text
41+
42+
Required: False
43+
Position: 1
44+
Default value: None
45+
Accept pipeline input: False
46+
Accept wildcard characters: False
47+
```
48+
49+
### -Term
50+
{{ Fill Term Description }}
51+
52+
```yaml
53+
Type: String
54+
Parameter Sets: (All)
55+
Aliases:
56+
57+
Required: False
58+
Position: 0
59+
Default value: None
60+
Accept pipeline input: False
61+
Accept wildcard characters: False
62+
```
63+
64+
### -ProgressAction
65+
{{ Fill ProgressAction Description }}
66+
67+
```yaml
68+
Type: ActionPreference
69+
Parameter Sets: (All)
70+
Aliases: proga
71+
72+
Required: False
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### CommonParameters
80+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
81+
82+
## INPUTS
83+
84+
### None
85+
86+
## OUTPUTS
87+
88+
### System.String
89+
90+
## NOTES
91+
92+
## RELATED LINKS
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
external help file: docs-workshop-help.xml
3+
Module Name: docs-workshop
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-DadJoke
9+
10+
## SYNOPSIS
11+
{{ Fill in the Synopsis }}
12+
13+
## SYNTAX
14+
15+
```
16+
Get-DadJoke [[-JokeId] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
{{ Fill in the Description }}
21+
22+
## EXAMPLES
23+
24+
### Example 1
25+
```powershell
26+
PS C:\> {{ Add example code here }}
27+
```
28+
29+
{{ Add example description here }}
30+
31+
## PARAMETERS
32+
33+
### -JokeId
34+
{{ Fill JokeId Description }}
35+
36+
```yaml
37+
Type: String
38+
Parameter Sets: (All)
39+
Aliases: Id
40+
41+
Required: False
42+
Position: 0
43+
Default value: None
44+
Accept pipeline input: False
45+
Accept wildcard characters: False
46+
```
47+
48+
### -ProgressAction
49+
{{ Fill ProgressAction Description }}
50+
51+
```yaml
52+
Type: ActionPreference
53+
Parameter Sets: (All)
54+
Aliases: proga
55+
56+
Required: False
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### CommonParameters
64+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
65+
66+
## INPUTS
67+
68+
### None
69+
70+
## OUTPUTS
71+
72+
### System.String
73+
74+
## NOTES
75+
76+
## RELATED LINKS

psakeFile.ps1

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ properties {
22
& dotnet tool restore
33
# Set this to $true to create a module with a monolithic PSM1
44
$PSBPreference.Build.CompileModule = $true
5-
$PSBPreference.Docs.RootDir = './docs'
5+
$PSBPreference.Build.CopyDirectories = 'cache'
6+
$PSBPreference.Docs.RootDir = './docs/commands/en-US'
67
$PSBPreference.General.ModuleVersion = (dotnet nbgv get-version -f json | ConvertFrom-Json).SimpleVersion
78
$PSBPreference.Help.DefaultLocale = 'en-US'
89
$PSBPreference.Test.OutputFile = 'out/testResults.xml'

tests/Meta.tests.ps1

Lines changed: 0 additions & 50 deletions
This file was deleted.

tests/MetaFixers.psm1

Lines changed: 0 additions & 80 deletions
This file was deleted.

0 commit comments

Comments
 (0)