Skip to content

Commit 7ebf023

Browse files
StartAutomatingStartAutomating
authored andcommitted
feat: Neocities HelpOut ( Fixes #8 )
1 parent 489d244 commit 7ebf023

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

docs/Remove-Neocities.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
Remove-Neocities
2+
----------------
3+
4+
### Synopsis
5+
Removes files from neocities
6+
7+
---
8+
9+
### Description
10+
11+
Removes files from a neocities site using the neocities API.
12+
13+
---
14+
15+
### Parameters
16+
#### **FileName**
17+
The name of the file to remove.
18+
19+
|Type |Required|Position|PipelineInput |Aliases |
20+
|------------|--------|--------|---------------------|-----------------|
21+
|`[String[]]`|true |1 |true (ByPropertyName)|FullName<br/>Path|
22+
23+
#### **Credential**
24+
The neocities credential
25+
Plural aliases are nice
26+
so are parameters that match the type name.
27+
A contextual alias is a good idea, too.
28+
And you may need to pluralize that contextual alias.
29+
30+
|Type |Required|Position|PipelineInput |Aliases |
31+
|----------------|--------|--------|---------------------|-----------------------------------------------------------------------------|
32+
|`[PSCredential]`|false |2 |true (ByPropertyName)|Credentials<br/>PSCredential<br/>NeocitiesCredential<br/>NeocitiesCredentials|
33+
34+
#### **AccessToken**
35+
The neocities access token.
36+
37+
|Type |Required|Position|PipelineInput |
38+
|----------|--------|--------|---------------------|
39+
|`[String]`|false |3 |true (ByPropertyName)|
40+
41+
#### **WhatIf**
42+
-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
43+
-WhatIf is used to see what would happen, or return operations without executing them
44+
#### **Confirm**
45+
-Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
46+
-Confirm is used to -Confirm each operation.
47+
48+
If you pass ```-Confirm:$false``` you will not be prompted.
49+
50+
If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed.
51+
52+
---
53+
54+
### Syntax
55+
```PowerShell
56+
Remove-Neocities [-FileName] <String[]> [[-Credential] <PSCredential>] [[-AccessToken] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
57+
```

0 commit comments

Comments
 (0)