Skip to content

Commit 775b05b

Browse files
authored
Merge pull request #321 from sdwheeler/sdw-w548067-repo-maint
Update README and markdownlint rules
1 parent 09842ad commit 775b05b

2 files changed

Lines changed: 31 additions & 28 deletions

File tree

.markdownlint.yaml

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,3 @@
1-
docsmd.alert: true
2-
docsmd.codesnippet: true
3-
docsmd.column: true
4-
docsmd.image: true
5-
docsmd.moniker: true
6-
docsmd.no-loc: true
7-
docsmd.row: true
8-
docsmd.securelinks: true
9-
docsmd.syntax: true
10-
docsmd.video: true
11-
docsmd.xref: true
12-
docsmd.zone: true
13-
141
MD001: true # header-increment
152
# MD002 # first-header-h1 - Superceded by MD041
163
MD003: # header-style
@@ -115,3 +102,20 @@ MD050: # strong-style
115102
MD051: true # link-fragments
116103
MD052: true # reference-links-images
117104
MD053: true # link-image-reference-definitions
105+
MD054: # link-image-style
106+
autolink: false # Allow autolinks (default true)
107+
collapsed: false # Allow collapsed reference links and images (default true)
108+
full: true # Allow full reference links and images (default true)
109+
inline: true # Allow inline links and images (default true)
110+
shortcut: false # Allow shortcut reference links and images (default true)
111+
url_inline: true # Allow URLs as inline links (default true)
112+
MD055: # table-pipe-style
113+
style: leading_and_trailing
114+
MD056: true # table-column-count
115+
# MD057: # not used by linter - never defined
116+
MD058: true # blanks-around-tables
117+
MD059: # descriptive-link-text
118+
prohibited_texts: ["click here","here","link","more"]
119+
MD060: # table-column-style
120+
aligned_delimiter: false
121+
style: any

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
ms.date: 01/03/2025
2+
ms.date: 01/27/2026
33
---
4-
# PowerShellGet & PSGallery documentation
4+
# Package manager & PSGallery documentation
55

6-
Welcome to the PowerShell-Docs-PSGet repository, the home of the official
7-
documentation for PowerShellGet and the PowerShell Gallery.
6+
Welcome to the PowerShell-Docs-PSGet repository, the home of the official documentation for
7+
PSResourceGet, PowerShellGet, and the PowerShell Gallery.
88

99
## Microsoft Open Source Code of Conduct
1010

@@ -14,29 +14,26 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc].
1414

1515
[![Build Status][cabgen-status]][cabgen-log]
1616

17-
[cabgen-status]: https://apidrop.visualstudio.com/Content%20CI/_apis/build/status/PROD/CabGen(PowerShell_Updatable_Help)/GitHub_MicrosoftDocs_PowerShell-Docs-PSGet/8f69f151-baa4-9541-9991-266b76474533_cabgen_Publish-Updatable-Help?repoName=MicrosoftDocs%2FPowerShell-Docs-PSGet&branchName=live
18-
[cabgen-log]: https://apidrop.visualstudio.com/Content%20CI/_build/latest?definitionId=5501&repoName=MicrosoftDocs%2FPowerShell-Docs-PSGet&branchName=live
19-
2017
## Repository Structure
2118

2219
The following list describes the main folders in this repository.
2320

21+
- `.devcontainer` - contains devcontainer settings used by GitHub Codespaces and Visual Studio Code
22+
(VS Code) Remote - Containers extension
2423
- `.github` - contains configuration settings used by GitHub for this repository
25-
- `.vscode` - contains configuration settings and recommended extensions for Visual Studio Code (VS
26-
Code)
24+
- `.vscode` - contains configuration settings and recommended extensions for VS Code
2725
- `powershell-gallery` - contains the documentation published to
2826
[learn.microsoft.com/powershell/gallery][04]. This includes both reference and conceptual content.
29-
- `powershellget-1.x` - contains the cmdlet reference and about topics for PowerShellGet 1.x
30-
- `powershellget-2.x` - contains the cmdlet reference and about topics for PowerShellGet 2.x
31-
- `powershellget-3.x` - contains the cmdlet reference and about topics for PowerShellGet 3.x
3227
- `breadcrumb` - contains the TOC used for breadcrumb navigation
3328
- `docs-conceptual` - contains the conceptual articles that are published to the Docs site. In
3429
general, the folder structure mirrors the Table of Contents (TOC).
30+
- `media` - contains image files used in documentation. There are media folders throughout the
31+
`docs-conceptual` content. See the Contributor Guide for information on using images in
32+
documentation.
3533
- `includes` - contains markdown include files
3634
- `mapping` - contains the version mapping configuration used by the build system
37-
- `media` - contains image files used in documentation. There are media folders throughout the
38-
`docs-conceptual` content. See the Contributor Guide for information on using images in
39-
documentation.
35+
- `powershellget-2.x` - contains the cmdlet reference and about topics for PowerShellGet 2.x
36+
- `powershellget-3.x` - contains the cmdlet reference and about topics for PSResourceGet
4037

4138
> [!NOTE]
4239
> The reference content (in the numbered folders) is used to create the webpages on the Docs site as
@@ -64,3 +61,5 @@ repo. The Creative Commons license applies to the documentation.
6461
[03]: https://cla.microsoft.com/
6562
[04]: https://learn.microsoft.com/powershell/gallery/
6663
[coc]: CODE_OF_CONDUCT.md
64+
[cabgen-status]: https://apidrop.visualstudio.com/Content%20CI/_apis/build/status/PROD/CabGen(PowerShell_Updatable_Help)/GitHub_MicrosoftDocs_PowerShell-Docs-PSGet/8f69f151-baa4-9541-9991-266b76474533_cabgen_Publish-Updatable-Help?repoName=MicrosoftDocs%2FPowerShell-Docs-PSGet&branchName=live
65+
[cabgen-log]: https://apidrop.visualstudio.com/Content%20CI/_build/latest?definitionId=5501&repoName=MicrosoftDocs%2FPowerShell-Docs-PSGet&branchName=live

0 commit comments

Comments
 (0)