Migrated to Microsoft GitHub org #145 (#169)

This commit is contained in:
Bernie White 2021-07-01 10:26:42 +10:00 коммит произвёл GitHub
Родитель d185736a28
Коммит 347e94ae6f
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
163 изменённых файлов: 769 добавлений и 222 удалений

Просмотреть файл

@ -230,7 +230,7 @@ stages:
action: edit
tag: '$(Build.SourceBranchName)'
releaseNotesSource: inline
releaseNotesInline: 'See [change log](https://github.com/BernieWhite/PSDocs/blob/main/CHANGELOG.md)'
releaseNotesInline: 'See [change log](https://github.com/Microsoft/PSDocs/blob/main/CHANGELOG.md)'
assetUploadMode: replace
addChangeLog: false
isPreRelease: $(isPreRelease)

Просмотреть файл

@ -1,3 +1,6 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
#
# Install dependencies for integration with Azure DevOps
#

2
.github/CODEOWNERS поставляемый
Просмотреть файл

@ -1,2 +1,2 @@
# https://help.github.com/articles/about-codeowners/
* @BernieWhite
* @microsoft/psdocs

2
.github/ISSUE_TEMPLATE/question.md поставляемый
Просмотреть файл

@ -8,4 +8,4 @@ We use Issues as an issue tracker; for help, discussion, and support questions,
Thanks! 😁.
- https://github.com/BernieWhite/PSDocs/discussions
- https://github.com/Microsoft/PSDocs/discussions

2
.github/PULL_REQUEST_TEMPLATE.md поставляемый
Просмотреть файл

@ -11,4 +11,4 @@
- **Code changes**
- [ ] Have unit tests created/ updated
- [ ] Link to a filed issue
- [ ] [Change log](https://github.com/BernieWhite/PSDocs/blob/main/CHANGELOG.md) has been updated with change under unreleased section
- [ ] [Change log](https://github.com/Microsoft/PSDocs/blob/main/CHANGELOG.md) has been updated with change under unreleased section

12
.github/dependabot.yml поставляемый
Просмотреть файл

@ -16,8 +16,18 @@ updates:
labels:
- 'dependencies'
reviewers:
- 'berniewhite'
- 'microsoft/psdocs'
ignore:
# Ignore upgrades to PS 7.1 for tool chain components at this time
# Testing against PS 7.1 is already completed
- dependency-name: 'Microsoft.PowerShell.SDK'
# Maintain dependencies for GitHub Actions
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: 'daily'
labels:
- 'ci-quality'
reviewers:
- 'microsoft/psdocs'

21
.github/workflows/analyze.yaml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,21 @@
#
# Repository validation
#
name: Analyze
on:
- pull_request
jobs:
analyze:
name: Analyze repository
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Run PSRule analysis
uses: Microsoft/ps-rule@main
with:
modules: PSRule.Rules.MSFT.OSS
prerelease: true

29
.github/workflows/stale.yaml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,29 @@
#
# Stale issues
#
name: 'Close stale issues'
on:
schedule:
- cron: '30 1 * * *'
jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v3
with:
stale-issue-message: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs within 7 days.
Thank you for your contributions.
close-issue-message: 'This issue was closed because it has not had any recent activity.'
days-before-stale: 14
days-before-pr-stale: -1
days-before-close: 7
days-before-pr-close: -1
any-of-labels: 'question,duplicate,incomplete'
stale-issue-label: stale

22
.vscode/tasks.json поставляемый
Просмотреть файл

@ -11,7 +11,9 @@
"kind": "test",
"isDefault": true
},
"problemMatcher": [ "$pester" ],
"problemMatcher": [
"$pester"
],
"presentation": {
"panel": "dedicated",
"clear": true
@ -21,7 +23,9 @@
"label": "coverage",
"type": "shell",
"command": "Invoke-Build Test -CodeCoverage",
"problemMatcher": [ "$pester" ]
"problemMatcher": [
"$pester"
]
},
{
"label": "build",
@ -60,6 +64,20 @@
"clear": true,
"panel": "dedicated"
}
},
{
"type": "PSRule",
"problemMatcher": [
"$PSRule"
],
"label": "PSRule: Run analysis",
"modules": [
"PSRule.Rules.MSFT.OSS"
],
"presentation": {
"panel": "dedicated",
"clear": true
}
}
]
}

Просмотреть файл

@ -2,41 +2,47 @@
## Unreleased
What's changed since pre-release v0.9.0-B2106004:
- Engineering:
- Migrated PSDocs to Microsoft GitHub organization. [#145](https://github.com/microsoft/PSDocs/issues/145)
- Bump YamlDotNet dependency to v11.2.1. [#168](https://github.com/microsoft/PSDocs/pull/168)
## v0.9.0-B2106004 (pre-release)
What's changed since pre-release v0.9.0-B2102002:
- Engineering:
- Bump YamlDotNet dependency to v11.2.0. [#165](https://github.com/BernieWhite/PSDocs/pull/165)
- Bump YamlDotNet dependency to v11.2.0. [#165](https://github.com/Microsoft/PSDocs/pull/165)
## v0.9.0-B2102002 (pre-release)
What's changed since v0.8.0:
- General improvements:
- Added support for document data and metadata in `end` convention blocks. [#148](https://github.com/BernieWhite/PSDocs/issues/148)
- Added support for document data and metadata in `end` convention blocks. [#148](https://github.com/Microsoft/PSDocs/issues/148)
## v0.8.0
What's changed since v0.7.0:
- Engine features:
- Added support for running custom actions using conventions. [#18](https://github.com/BernieWhite/PSDocs/issues/18)
[#120](https://github.com/BernieWhite/PSDocs/issues/120)
- Added support for running custom actions using conventions. [#18](https://github.com/Microsoft/PSDocs/issues/18)
[#120](https://github.com/Microsoft/PSDocs/issues/120)
- Conventions provide `Begin`, `Process` and `End` blocks to hook into the document pipeline.
- Name or change the output path of documents in `Begin` and `Process` blocks.
- Generate table of contents (TOC) and perform publishing actions in `End` blocks.
- See [about_PSDocs_Conventions] for more details.
- Added support for custom configuration key values. [#121](https://github.com/BernieWhite/PSDocs/issues/121)
- Added support for custom configuration key values. [#121](https://github.com/Microsoft/PSDocs/issues/121)
- See [about_PSDocs_Configuration] for more details.
- General improvements:
- Improve handling when an empty document title is set. [#122](https://github.com/BernieWhite/PSDocs/issues/122)
- Added `-Replace` parameter to `Include` keyword to replace tokens in included file. [#134](https://github.com/BernieWhite/PSDocs/issues/134)
- Improve handling when an empty document title is set. [#122](https://github.com/Microsoft/PSDocs/issues/122)
- Added `-Replace` parameter to `Include` keyword to replace tokens in included file. [#134](https://github.com/Microsoft/PSDocs/issues/134)
- A hashtable of replacement tokens can be specified to replace contents within original file.
- See [about_PSDocs_Keywords] for more details.
- Bug fixes:
- Fixed boolean string conversion with the `GetBoolOrDefault` configuration helper. [#140](https://github.com/BernieWhite/PSDocs/issues/140)
- Fixed use of error action preference with `Include` keyword. [#127](https://github.com/BernieWhite/PSDocs/issues/127)
- Fixed boolean string conversion with the `GetBoolOrDefault` configuration helper. [#140](https://github.com/Microsoft/PSDocs/issues/140)
- Fixed use of error action preference with `Include` keyword. [#127](https://github.com/Microsoft/PSDocs/issues/127)
What's changed since pre-release v0.8.0-B2102012:
@ -47,21 +53,21 @@ What's changed since pre-release v0.8.0-B2102012:
What's changed since pre-release v0.8.0-B2101011:
- Engine features:
- Added support for running custom actions using conventions. [#18](https://github.com/BernieWhite/PSDocs/issues/18)
[#120](https://github.com/BernieWhite/PSDocs/issues/120)
- Added support for running custom actions using conventions. [#18](https://github.com/Microsoft/PSDocs/issues/18)
[#120](https://github.com/Microsoft/PSDocs/issues/120)
- Conventions provide `Begin`, `Process` and `End` blocks to hook into the document pipeline.
- Name or change the output path of documents in `Begin` and `Process` blocks.
- Generate table of contents (TOC) and perform publishing actions in `End` blocks.
- See [about_PSDocs_Conventions] for more details.
- Bug fixes:
- Fixed boolean string conversion with the `GetBoolOrDefault` configuration helper. [#140](https://github.com/BernieWhite/PSDocs/issues/140)
- Fixed boolean string conversion with the `GetBoolOrDefault` configuration helper. [#140](https://github.com/Microsoft/PSDocs/issues/140)
## v0.8.0-B2101011 (pre-release)
What's changed since pre-release v0.8.0-B2101006:
- General improvements:
- Added `-Replace` parameter to `Include` keyword to replace tokens in included file. [#134](https://github.com/BernieWhite/PSDocs/issues/134)
- Added `-Replace` parameter to `Include` keyword to replace tokens in included file. [#134](https://github.com/Microsoft/PSDocs/issues/134)
- A hashtable of replacement tokens can be specified to replace contents within original file.
- See [about_PSDocs_Keywords] for more details.
@ -70,28 +76,28 @@ What's changed since pre-release v0.8.0-B2101006:
What's changed since v0.7.0:
- Engine features:
- Added support for custom configuration key values. [#121](https://github.com/BernieWhite/PSDocs/issues/121)
- Added support for custom configuration key values. [#121](https://github.com/Microsoft/PSDocs/issues/121)
- See [about_PSDocs_Configuration] for more details.
- General improvements:
- Improve handling when an empty document title is set. [#122](https://github.com/BernieWhite/PSDocs/issues/122)
- Improve handling when an empty document title is set. [#122](https://github.com/Microsoft/PSDocs/issues/122)
- Bug fixes:
- Fixed use of error action preference with `Include` keyword. [#127](https://github.com/BernieWhite/PSDocs/issues/127)
- Fixed use of error action preference with `Include` keyword. [#127](https://github.com/Microsoft/PSDocs/issues/127)
## v0.7.0
What's changed since v0.6.3:
- Engine features:
- Added support for MacOS and Linux. [#59](https://github.com/BernieWhite/PSDocs/issues/59)
- Added support for using document definitions from modules. [#81](https://github.com/BernieWhite/PSDocs/issues/81)
- Added support for localized strings using the `$LocalizedData` variable. [#91](https://github.com/BernieWhite/PSDocs/issues/91)
- Automatically serialize `Code` objects to JSON and YAML. [#93](https://github.com/BernieWhite/PSDocs/issues/93)
- Added support for MacOS and Linux. [#59](https://github.com/Microsoft/PSDocs/issues/59)
- Added support for using document definitions from modules. [#81](https://github.com/Microsoft/PSDocs/issues/81)
- Added support for localized strings using the `$LocalizedData` variable. [#91](https://github.com/Microsoft/PSDocs/issues/91)
- Automatically serialize `Code` objects to JSON and YAML. [#93](https://github.com/Microsoft/PSDocs/issues/93)
- Use the `json`, `yaml`, or `yml` info strings to automatically serialize custom objects.
- See [about_PSDocs_Keywords] for more details.
- General improvements:
- Added configuration for setting output options. [#105](https://github.com/BernieWhite/PSDocs/issues/105)
- Added parameter alias `-MarkdownEncoding` on `New-PSDocumentOption` for `-Encoding`. [#106](https://github.com/BernieWhite/PSDocs/issues/106)
- Default the info string to `powershell` for `Code` script blocks. [#92](https://github.com/BernieWhite/PSDocs/issues/92)
- Added configuration for setting output options. [#105](https://github.com/Microsoft/PSDocs/issues/105)
- Added parameter alias `-MarkdownEncoding` on `New-PSDocumentOption` for `-Encoding`. [#106](https://github.com/Microsoft/PSDocs/issues/106)
- Default the info string to `powershell` for `Code` script blocks. [#92](https://github.com/Microsoft/PSDocs/issues/92)
- See [about_PSDocs_Keywords] for more details.
- Deprecations and removals:
- Added [upgrade notes](docs/upgrade-notes.md) for migration from v0.6.x to v0.7.0.
@ -106,8 +112,8 @@ What's changed since v0.6.3:
- Engineering:
- Bump YamlDotNet dependency to v8.1.2.
- Bug fixes:
- Fixed inconsistencies with default options file name. [#103](https://github.com/BernieWhite/PSDocs/issues/103)
- Fixed line break after block quote. [#104](https://github.com/BernieWhite/PSDocs/issues/104)
- Fixed inconsistencies with default options file name. [#103](https://github.com/Microsoft/PSDocs/issues/103)
- Fixed line break after block quote. [#104](https://github.com/Microsoft/PSDocs/issues/104)
See [upgrade notes](docs/upgrade-notes.md) for helpful information when upgrading from previous versions.
@ -120,32 +126,32 @@ What's changed since pre-release v0.7.0-B2101015:
What's changed since pre-release v0.7.0-B2008035:
- Engine features:
- Added support for localized strings using the `$LocalizedData` variable. [#91](https://github.com/BernieWhite/PSDocs/issues/91)
- Automatically serialize `Code` objects to JSON and YAML. [#93](https://github.com/BernieWhite/PSDocs/issues/93)
- Added support for localized strings using the `$LocalizedData` variable. [#91](https://github.com/Microsoft/PSDocs/issues/91)
- Automatically serialize `Code` objects to JSON and YAML. [#93](https://github.com/Microsoft/PSDocs/issues/93)
- Use the `json`, `yaml`, or `yml` info strings to automatically serialize custom objects.
- See [about_PSDocs_Keywords] for more details.
- General improvements:
- Added configuration for setting output options. [#105](https://github.com/BernieWhite/PSDocs/issues/105)
- Added parameter alias `-MarkdownEncoding` on `New-PSDocumentOption` for `-Encoding`. [#106](https://github.com/BernieWhite/PSDocs/issues/106)
- Default the info string to `powershell` for `Code` script blocks. [#92](https://github.com/BernieWhite/PSDocs/issues/92)
- Added configuration for setting output options. [#105](https://github.com/Microsoft/PSDocs/issues/105)
- Added parameter alias `-MarkdownEncoding` on `New-PSDocumentOption` for `-Encoding`. [#106](https://github.com/Microsoft/PSDocs/issues/106)
- Default the info string to `powershell` for `Code` script blocks. [#92](https://github.com/Microsoft/PSDocs/issues/92)
- See [about_PSDocs_Keywords] for more details.
- Bug fixes:
- Fixed inconsistencies with default options file name. [#103](https://github.com/BernieWhite/PSDocs/issues/103)
- Fixed line break after block quote. [#104](https://github.com/BernieWhite/PSDocs/issues/104)
- Fixed inconsistencies with default options file name. [#103](https://github.com/Microsoft/PSDocs/issues/103)
- Fixed line break after block quote. [#104](https://github.com/Microsoft/PSDocs/issues/104)
## v0.7.0-B2008035 (pre-release)
What's changed since pre-release v0.7.0-B2008022:
- Engine features:
- Added support for using document definitions from modules. [#81](https://github.com/BernieWhite/PSDocs/issues/81)
- Added support for using document definitions from modules. [#81](https://github.com/Microsoft/PSDocs/issues/81)
## v0.7.0-B2008022 (pre-release)
What's changed since v0.6.3:
- Engine features:
- Added support for MacOS and Linux. [#59](https://github.com/BernieWhite/PSDocs/issues/59)
- Added support for MacOS and Linux. [#59](https://github.com/Microsoft/PSDocs/issues/59)
- Deprecations and removals:
- Added [upgrade notes](docs/upgrade-notes.md) for migration from v0.6.x to v0.7.0.
- **Breaking change**: Removed support for inline document blocks.
@ -166,22 +172,22 @@ See [upgrade notes](docs/upgrade-notes.md) for helpful information when upgradin
What's changed since v0.6.2:
- Bug fixes:
- Fix concatenation of multiple lines in Code section. [#69](https://github.com/BernieWhite/PSDocs/issues/69)
- Fix concatenation of multiple lines in Code section. [#69](https://github.com/Microsoft/PSDocs/issues/69)
## v0.6.2
What's changed since v0.6.1:
- Bug fixes:
- Fixed PositionMessage cannot be found on this object. [#63](https://github.com/BernieWhite/PSDocs/issues/63)
- Fixed handling of null metadata hashtable. [#60](https://github.com/BernieWhite/PSDocs/issues/60)
- Fixed PositionMessage cannot be found on this object. [#63](https://github.com/Microsoft/PSDocs/issues/63)
- Fixed handling of null metadata hashtable. [#60](https://github.com/Microsoft/PSDocs/issues/60)
## v0.6.1
What's changed since v0.6.0:
- Bug fixes:
- Fixed null reference for table columns with undefined properties. [#53](https://github.com/BernieWhite/PSDocs/issues/53)
- Fixed null reference for table columns with undefined properties. [#53](https://github.com/Microsoft/PSDocs/issues/53)
## v0.6.0
@ -198,7 +204,7 @@ What's changed since v0.5.0:
- Added new contextual help topic to provide details on automatic variables exposed for PSDocs for use within document definitions.
- Added support for locked down environments to ensure that documents are executed as constrained code when Device Guard is used.
- Use the `Execution.LanguageMode = 'ConstrainedLanguage'` option to force constrained language mode.
- **Important change**: Improved markdown formatting for tables. [#31](https://github.com/BernieWhite/PSDocs/issues/31)
- **Important change**: Improved markdown formatting for tables. [#31](https://github.com/Microsoft/PSDocs/issues/31)
- Table columns are now padded by default to match header width.
Set `Markdown.ColumnPadding` option to `None` to match format style from PSDocs <= 0.5.0.
- Pipe characters on the start and end of a table row are not added by default.
@ -223,15 +229,15 @@ What's changed since v0.5.0:
What's changed since v0.4.0:
- Engine features:
- Added support for property expressions with the `Table` keyword. [#27](https://github.com/BernieWhite/PSDocs/issues/27)
- Added support for building all document definitions from a path using the `-Path` parameter. [#25](https://github.com/BernieWhite/PSDocs/issues/25)
- Added support for property expressions with the `Table` keyword. [#27](https://github.com/Microsoft/PSDocs/issues/27)
- Added support for building all document definitions from a path using the `-Path` parameter. [#25](https://github.com/Microsoft/PSDocs/issues/25)
- Additionally document definitions can be filtered with the `-Name` and `-Tag` parameter.
- This is the recommended way to build documents going forward.
- Added support for providing options for `Invoke-PSDocument` using YAML, see `about_PSDocs_Options`.
- General improvements:
- **Important change**: Deprecated support for using `Invoke-PSDocument` with inline document definitions.
- Improved support for using named document definitions inline, use this to call inline document definitions.
- **Breaking change**: Empty `Section` blocks are not rendered by default. [#32](https://github.com/BernieWhite/PSDocs/issues/32)
- **Breaking change**: Empty `Section` blocks are not rendered by default. [#32](https://github.com/Microsoft/PSDocs/issues/32)
- Use `-Force` parameter on specific sections or `Markdown.SkipEmptySections = $False` option to force empty sections to be written.
- Bug fixes:
- Fixed to prevent string builder properties being outputted each time `Invoke-PSDocument` is called.
@ -246,11 +252,11 @@ What's changed since v0.3.0:
- General improvements:
- **Important change**: Renamed `Yaml` keyword to `Metadata`.
`Yaml` keyword is still supported but deprecated, switch to using `Metadata` instead.
- **Breaking change**: Added support for encoding markdown content output. [#16](https://github.com/BernieWhite/PSDocs/issues/16)
- **Breaking change**: Added support for encoding markdown content output. [#16](https://github.com/Microsoft/PSDocs/issues/16)
- To specify the encoding use the `-Encoding` parameter of `Invoke-PSDocument` and `Invoke-DscNodeDocument`.
- Output now defaults to UTF-8 without byte order mark (BOM) instead of ASCII.
- Bug fixes:
- Fixed handling of line break for multiline table columns using a wrap separator. [#11](https://github.com/BernieWhite/PSDocs/issues/11)
- Fixed handling of line break for multiline table columns using a wrap separator. [#11](https://github.com/Microsoft/PSDocs/issues/11)
## v0.3.0

9
CODE_OF_CONDUCT.md Normal file
Просмотреть файл

@ -0,0 +1,9 @@
# Microsoft Open Source Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
Resources:
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns

72
CONTRIBUTING.md Normal file
Просмотреть файл

@ -0,0 +1,72 @@
# Contributing
This project welcomes contributions and suggestions. Most contributions require you to
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
and actually do, grant us the rights to use your contribution. For details, visit
https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## How to contribute
- File or vote up issues
- Improve documentation
- Fix bugs or add features
### Intro to Git and GitHub
When contributing to documentation or code changes, you'll need to have a GitHub account and a basic understanding of Git.
Check out the links below to get started.
- Make sure you have a [GitHub account][github-signup].
- GitHub Help:
- [Git and GitHub learning resources][learn-git].
- [GitHub Flow Guide][github-flow].
- [Fork a repo][github-fork].
- [About Pull Requests][github-pr].
## Contributing to issues
- Check if the issue you are going to file already exists in our GitHub [issues][issue].
- If you do not see your problem captured, please file a new issue and follow the provided template.
- If the an open issue exists for the problem you are experiencing, vote up the issue or add a comment.
## Contributing to code
- Before writing a fix or feature enhancement, ensure that an issue is logged.
- Be prepared to discuss a feature and take feedback.
- Include unit tests and updates documentation to complement the change.
When you are ready to contribute a fix or feature:
- Start by [forking the PSDocs repo][github-fork].
- Create a new branch from main in your fork.
- Add commits in your branch.
- If you have updated module code also update `CHANGELOG.md`.
- You don't need to update the `CHANGELOG.md` for changes to unit tests or documentation.
- Try building your changes locally. See [building from source][build] for instructions.
- [Create a pull request][github-pr-create] to merge changes into the PSRule `main` branch.
- If you are _ready_ for your changes to be reviewed create a _pull request_.
- If you are _not ready_ for your changes to be reviewed, create a _draft pull request_.
- An continuous integration (CI) process will automatically build your changes.
- You changes must build successfully to be merged.
- If you have any build errors, push new commits to your branch.
- Avoid using forced pushes or squashing changes while in review, as this makes reviewing your changes harder.
[learn-git]: https://help.github.com/en/articles/git-and-github-learning-resources
[github-flow]: https://guides.github.com/introduction/flow/
[github-signup]: https://github.com/signup/free
[github-fork]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo
[github-pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
[github-pr-create]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork
[build]: docs/scenarios/install-instructions.md#building-from-source
[issue]: https://github.com/Microsoft/PSDocs/issues
[discussion]: https://github.com/Microsoft/PSDocs/discussions

Просмотреть файл

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2017 Microsoft Corporation
Copyright (c) Microsoft Corporation.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

Просмотреть файл

@ -4,12 +4,15 @@ A PowerShell module with commands to generate markdown from objects using PowerS
![ci-badge]
## Disclaimer
## Support
This project is open source and **not a supported product**.
This project uses GitHub Issues to track bugs and feature requests.
Please search the existing issues before filing new issues to avoid duplicates.
If you are experiencing problems, have a feature request, or a question, please check for an [issue] on GitHub.
If you do not see your problem captured, please file a new issue, and follow the provided template.
- For new issues, file your bug or feature request as a new [issue].
- For help, discussion, and support questions about using this project, join or start a [discussion].
Support for this project/ product is limited to the resources listed above.
## Getting the modules
@ -142,9 +145,10 @@ The following conceptual topics exist in the `PSDocs` module:
The following projects use or integrate with PSDocs.
Name | Description
---- | -----------
[PSDocs.Dsc] | Extension for PSDocs to generate markdown from Desired State Configuration.
Name | Description
---- | -----------
[PSDocs.Azure] | Generate documentation from Azure infrastructure as code (IaC) artifacts.
[PSDocs.Dsc] | Extension for PSDocs to generate markdown from Desired State Configuration.
## Changes and versioning
@ -156,6 +160,17 @@ For a list of module changes please see the [change log](CHANGELOG.md).
> Pre-release versions should be considered experimental.
> Modules and change log details for pre-releases will be removed as standard releases are made available.
## Contributing
This project welcomes contributions and suggestions.
If you are ready to contribute, please visit the [contribution guide](CONTRIBUTING.md).
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Maintainers
- [Bernie White](https://github.com/BernieWhite)
@ -165,9 +180,11 @@ For a list of module changes please see the [change log](CHANGELOG.md).
This project is [licensed under the MIT License](LICENSE).
[install]: docs/install-instructions.md
[issue]: https://github.com/BernieWhite/PSDocs/issues
[issue]: https://github.com/Microsoft/PSDocs/issues
[discussion]: https://github.com/Microsoft/PSDocs/discussions
[ci-badge]: https://bewhite.visualstudio.com/PSDocs/_apis/build/status/PSDocs-CI?branchName=main
[psg-psdocs]: https://www.powershellgallery.com/packages/PSDocs
[psg-psdocs-version-badge]: https://img.shields.io/powershellgallery/v/PSDocs.svg
[psg-psdocs-installs-badge]: https://img.shields.io/powershellgallery/dt/PSDocs.svg
[PSDocs.Dsc]: https://www.powershellgallery.com/packages/PSDocs.Dsc
[PSDocs.Azure]: https://azure.github.io/PSDocs.Azure/

43
SECURITY.md Normal file
Просмотреть файл

@ -0,0 +1,43 @@
# Security policy
<!-- BEGIN MICROSOFT SECURITY.MD V0.0.5 BLOCK -->
## Security
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below.
## Reporting Security Issues
**Please do not report security vulnerabilities through public GitHub issues.**
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
* Full paths of source file(s) related to the manifestation of the issue
* The location of the affected source code (tag/branch/commit or direct URL)
* Any special configuration required to reproduce the issue
* Step-by-step instructions to reproduce the issue
* Proof-of-concept or exploit code (if possible)
* Impact of the issue, including how an attacker might exploit the issue
This information will help us triage your report more quickly.
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
## Preferred Languages
We prefer all communications to be in English.
## Policy
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
<!-- END MICROSOFT SECURITY.MD BLOCK -->

16
SUPPORT.md Normal file
Просмотреть файл

@ -0,0 +1,16 @@
# Support
## How to file issues and get help
This project uses GitHub Issues to track bugs and feature requests.
Please search the existing issues before filing new issues to avoid duplicates.
- For new issues, file your bug or feature request as a new [issue].
- For help, discussion, and support questions about using this project, join or start a [discussion].
## Microsoft Support Policy
Support for this project/ product is limited to the resources listed above.
[issue]: https://github.com/Microsoft/PSDocs/issues
[discussion]: https://github.com/Microsoft/PSDocs/discussions

Просмотреть файл

@ -1,3 +1,5 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# Note:
# This manually builds the project locally

Просмотреть файл

@ -1,7 +1,7 @@
---
external help file: PSDocs-help.xml
Module Name: PSDocs
online version: https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/Document.md
online version: https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/Document.md
schema: 2.0.0
---

Просмотреть файл

@ -1,7 +1,7 @@
---
external help file: PSDocs-help.xml
Module Name: PSDocs
online version: https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/Get-PSDocument.md
online version: https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/Get-PSDocument.md
schema: 2.0.0
---

Просмотреть файл

@ -1,7 +1,7 @@
---
external help file: PSDocs-help.xml
Module Name: PSDocs
online version: https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/Get-PSDocumentHeader.md
online version: https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/Get-PSDocumentHeader.md
schema: 2.0.0
---

Просмотреть файл

@ -1,7 +1,7 @@
---
external help file: PSDocs-help.xml
Module Name: PSDocs
online version: https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md
online version: https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md
schema: 2.0.0
---

Просмотреть файл

@ -1,7 +1,7 @@
---
external help file: PSDocs-help.xml
Module Name: PSDocs
online version: https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/New-PSDocumentOption.md
online version: https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/New-PSDocumentOption.md
schema: 2.0.0
---

Просмотреть файл

@ -1,7 +1,7 @@
---
Module Name: PSDocs
Module Guid: 1f6df554-c081-40d8-9aca-32c1abe4a1b6
Download Help Link: https://github.com/BernieWhite/PSDocs
Download Help Link: https://github.com/Microsoft/PSDocs
Help Version: 0.1.0.0
Locale: en-US
---

Просмотреть файл

@ -82,11 +82,11 @@ if ($PSDocs.Configuration.GetBoolOrDefault('SAMPLE_USE_PARAMETERS_SNIPPET', $Tru
## NOTE
An online version of this document is available at https://github.com/BernieWhite/PSDocs/blob/main/docs/concepts/PSDocs/en-US/about_PSDocs_Configuration.md.
An online version of this document is available at https://github.com/Microsoft/PSDocs/blob/main/docs/concepts/PSDocs/en-US/about_PSDocs_Configuration.md.
## SEE ALSO
- [Invoke-PSDocument](https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md)
- [Invoke-PSDocument](https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md)
## KEYWORDS

Просмотреть файл

@ -126,11 +126,11 @@ Export-PSDocumentConvention 'TestNamingConvention1' {
## NOTE
An online version of this document is available at https://github.com/BernieWhite/PSDocs/blob/main/docs/concepts/PSDocs/en-US/about_PSDocs_Conventions.md.
An online version of this document is available at https://github.com/Microsoft/PSDocs/blob/main/docs/concepts/PSDocs/en-US/about_PSDocs_Conventions.md.
## SEE ALSO
- [Invoke-PSDocument](https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md)
- [Invoke-PSDocument](https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md)
## KEYWORDS

Просмотреть файл

@ -382,12 +382,12 @@ output:
## NOTE
An online version of this document is available at https://github.com/BernieWhite/PSDocs/blob/main/docs/concepts/PSDocs/en-US/about_PSDocs_Options.md.
An online version of this document is available at https://github.com/Microsoft/PSDocs/blob/main/docs/concepts/PSDocs/en-US/about_PSDocs_Options.md.
## SEE ALSO
- [Invoke-PSDocument](https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md)
- [New-PSDocumentOption](https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/New-PSDocumentOption.md)
- [Invoke-PSDocument](https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md)
- [New-PSDocumentOption](https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/New-PSDocumentOption.md)
## KEYWORDS

Просмотреть файл

@ -231,11 +231,11 @@ The current section title is Introduction.
## NOTE
An online version of this document is available at https://github.com/BernieWhite/PSDocs/blob/main/docs/concepts/PSDocs/en-US/about_PSDocs_Variables.md.
An online version of this document is available at https://github.com/Microsoft/PSDocs/blob/main/docs/concepts/PSDocs/en-US/about_PSDocs_Variables.md.
## SEE ALSO
- [Invoke-PSDocument](https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md)
- [Invoke-PSDocument](https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md)
## KEYWORDS

Просмотреть файл

@ -633,11 +633,11 @@ Document 'Sample' {
## NOTE
An online version of this document is available at https://github.com/BernieWhite/PSDocs/blob/main/docs/keywords/PSDocs/en-US/about_PSDocs_Keywords.md.
An online version of this document is available at https://github.com/Microsoft/PSDocs/blob/main/docs/keywords/PSDocs/en-US/about_PSDocs_Keywords.md.
## SEE ALSO
- [Invoke-PSDocument](https://github.com/BernieWhite/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md)
- [Invoke-PSDocument](https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/Invoke-PSDocument.md)
## KEYWORDS

Просмотреть файл

@ -1,3 +1,6 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
#
# Azure Resource Manager documentation definitions
#

Просмотреть файл

@ -1,3 +1,5 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
[CmdletBinding()]
param (
@ -85,44 +87,6 @@ function CopyModuleFiles {
}
}
function Get-RepoRuleData {
[CmdletBinding()]
param (
[Parameter(Position = 0, Mandatory = $False)]
[String]$Path = $PWD
)
process {
GetPathInfo -Path $Path -Verbose:$VerbosePreference;
}
}
function GetPathInfo {
[CmdletBinding()]
param (
[Parameter(Mandatory = $True)]
[String]$Path
)
begin {
$items = New-Object -TypeName System.Collections.ArrayList;
}
process {
$Null = $items.Add((Get-Item -Path $Path));
$files = @(Get-ChildItem -Path $Path -File -Recurse -Include *.ps1,*.psm1,*.psd1,*.cs | Where-Object {
!($_.FullName -like "*.Designer.cs") -and
!($_.FullName -like "*/bin/*") -and
!($_.FullName -like "*/obj/*") -and
!($_.FullName -like "*\obj\*") -and
!($_.FullName -like "*\bin\*") -and
!($_.FullName -like "*\out\*") -and
!($_.FullName -like "*/out/*")
});
$Null = $items.AddRange($files);
}
end {
$items;
}
}
task BuildDotNet {
exec {
dotnet restore

Просмотреть файл

@ -7,7 +7,7 @@ info:
repository:
type: git
url: https://github.com/BernieWhite/PSDocs.git
url: https://github.com/Microsoft/PSDocs.git
tasks:
clear:

15
ps-rule.yaml Normal file
Просмотреть файл

@ -0,0 +1,15 @@
#
# PSRule configuration
#
# Please see the documentation for all configuration options:
# https://microsoft.github.io/PSRule/
output:
culture:
- 'en-US'
input:
pathIgnore:
- '*.Designer.cs'
- '*.md'

Просмотреть файл

@ -1,3 +1,6 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
#
# Document defintions for benchmarks
#

Просмотреть файл

@ -1,4 +1,7 @@
using BenchmarkDotNet.Attributes;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using BenchmarkDotNet.Attributes;
using PSDocs.Configuration;
using PSDocs.Models;
using PSDocs.Pipeline;

Просмотреть файл

@ -1,4 +1,7 @@
using BenchmarkDotNet.Analysers;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using BenchmarkDotNet.Analysers;
using BenchmarkDotNet.Columns;
using BenchmarkDotNet.Configs;
using BenchmarkDotNet.Loggers;

Просмотреть файл

@ -1,4 +1,7 @@
using PSDocs.Models;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Models;
using System.Collections.Generic;
using System.Management.Automation;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using Newtonsoft.Json;
using PSDocs.Models;
using PSDocs.Runtime;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Runtime;
using System.Management.Automation;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Definitions.Conventions;
using PSDocs.Runtime;
using System;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Models;
using PSDocs.Resources;
using PSDocs.Runtime;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
namespace PSDocs.Commands

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
namespace PSDocs.Commands

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Data.Internal;
using PSDocs.Pipeline;
using PSDocs.Runtime;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
namespace PSDocs.Commands

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections;
using System.Management.Automation;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
namespace PSDocs.Commands

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Configuration;
using PSDocs.Runtime;
using System.Management.Automation;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Models;
using System;
using System.Collections;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Pipeline;
using System.Management.Automation;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
namespace PSDocs.Commands

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Diagnostics;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections;
using System.Diagnostics;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using Newtonsoft.Json;
using PSDocs.Pipeline;
using PSDocs.Resources;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
namespace PSDocs

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
namespace PSDocs

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
using System.Management.Automation;

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Configuration
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Configuration
{
public enum ColumnPadding
{

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections;
using System.Collections.Generic;

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Configuration
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Configuration
{
public sealed class DocumentOption
{

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Configuration
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Configuration
{
public enum EdgePipeOption
{

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.ComponentModel;
namespace PSDocs.Configuration

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections;
using System.Collections.Generic;

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Configuration
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Configuration
{
public enum LanguageMode
{

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Configuration
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Configuration
{
public enum MarkdownEncoding
{

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.ComponentModel;
namespace PSDocs.Configuration

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.ComponentModel;
namespace PSDocs.Configuration

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Resources;
using System;
using System.Collections;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
namespace PSDocs.Data

Просмотреть файл

@ -1,4 +1,7 @@
using PSDocs.Models;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Models;
using PSDocs.Processor;
using PSDocs.Runtime;
using System;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Definitions;
using PSDocs.Models;
using PSDocs.Processor;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Runtime;
using System.Collections;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Configuration;
using PSDocs.Runtime;
using System.Collections;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Pipeline;
using PSDocs.Runtime;
using System.Collections;

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Runtime;
using System.Collections;

Просмотреть файл

@ -1,4 +1,7 @@
using PSDocs.Runtime;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Runtime;
namespace PSDocs.Definitions
{

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Models
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Models
{
public enum Alignment
{

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Models
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Models
{
public sealed class BlockQuote : DocumentNode
{

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Models
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Models
{
public sealed class Code : DocumentNode
{

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Runtime;
using System.Collections;
using System.Collections.Specialized;

Просмотреть файл

@ -1,4 +1,7 @@
using System;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
namespace PSDocs.Models

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Models
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Models
{
public abstract class DocumentNode
{

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Models
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Models
{
public enum DocumentNodeType
{

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.IO;
namespace PSDocs.Models

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Configuration;
using System.Collections;
using System.IO;

Просмотреть файл

@ -1,4 +1,7 @@
using PSDocs.Configuration;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Configuration;
using System.IO;
namespace PSDocs.Models

Просмотреть файл

@ -1,4 +1,7 @@
using System;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Collections.Generic;
namespace PSDocs.Models

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Models
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Models
{
public sealed class Section : SectionNode
{

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Management.Automation;

Просмотреть файл

@ -1,4 +1,7 @@
using System.Collections.Generic;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections.Generic;
namespace PSDocs.Models
{

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Pipeline;
using PSDocs.Resources;
using System;

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Models
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Models
{
public sealed class TableColumnHeader
{

Просмотреть файл

@ -1,4 +1,7 @@
namespace PSDocs.Models
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
namespace PSDocs.Models
{
public sealed class Text : DocumentNode
{

Просмотреть файл

@ -12,13 +12,13 @@
<!-- <TreatWarningsAsErrors>true</TreatWarningsAsErrors> -->
<Authors>Bernie White</Authors>
<AssemblyTitle>PSDocs</AssemblyTitle>
<RepositoryUrl>https://github.com/BernieWhite/PSDocs</RepositoryUrl>
<PackageLicenseExpression>https://github.com/BernieWhite/PSDocs/blob/main/LICENSE</PackageLicenseExpression>
<RepositoryUrl>https://github.com/Microsoft/PSDocs</RepositoryUrl>
<PackageLicenseExpression>https://github.com/Microsoft/PSDocs/blob/main/LICENSE</PackageLicenseExpression>
<Version>0.0.1</Version>
<Copyright>(c) Bernie White. All rights reserved.</Copyright>
<Copyright>Copyright (c) Microsoft Corporation. Licensed under the MIT License.</Copyright>
<Description>Generate markdown from objects using PowerShell syntax.
This project is to be considered a proof-of-concept and not a supported product.</Description>
This project uses GitHub Issues to track bugs and feature requests. See GitHub project for more information.</Description>
</PropertyGroup>
<PropertyGroup>

Просмотреть файл

@ -1,3 +1,6 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
#
# PSDocs module
#
@ -17,18 +20,18 @@ CompatiblePSEditions = 'Core', 'Desktop'
GUID = '1f6df554-c081-40d8-9aca-32c1abe4a1b6'
# Author of this module
Author = 'Bernie White'
Author = 'Microsoft Corporation'
# Company or vendor of this module
CompanyName = 'Bernie White'
CompanyName = 'Microsoft Corporation'
# Copyright statement for this module
Copyright = '(c) Bernie White. All rights reserved.'
Copyright = '(c) Microsoft Corporation. All rights reserved.'
# Description of the functionality provided by this module
Description = 'Generate markdown from PowerShell.
This project is to be considered a proof-of-concept and not a supported product.'
This project uses GitHub Issues to track bugs and feature requests. See GitHub project for more information.'
# Minimum version of the Windows PowerShell engine required by this module
PowerShellVersion = '5.1'
@ -117,16 +120,16 @@ PrivateData = @{
Tags = @('Markdown', 'PSDocs', 'DevOps', 'CI')
# A URL to the license for this module.
LicenseUri = 'https://github.com/BernieWhite/PSDocs/blob/main/LICENSE'
LicenseUri = 'https://github.com/Microsoft/PSDocs/blob/main/LICENSE'
# A URL to the main website for this project.
ProjectUri = 'https://github.com/BernieWhite/PSDocs'
ProjectUri = 'https://github.com/Microsoft/PSDocs'
# A URL to an icon representing this module.
# IconUri = ''
# ReleaseNotes of this module
ReleaseNotes = 'https://github.com/BernieWhite/PSDocs/releases'
ReleaseNotes = 'https://github.com/Microsoft/PSDocs/releases'
} # End of PSData hashtable

Просмотреть файл

@ -1,3 +1,6 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
#
# PSDocs module
#

Просмотреть файл

@ -1,4 +1,7 @@
using System;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System;
using System.Runtime.Serialization;
using System.Security.Permissions;

Просмотреть файл

@ -1,4 +1,7 @@
using PSDocs.Runtime;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Runtime;
namespace PSDocs.Pipeline
{

Просмотреть файл

@ -1,4 +1,7 @@
using System.Management.Automation;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Management.Automation;
namespace PSDocs.Pipeline
{

Просмотреть файл

@ -1,4 +1,7 @@
using System.Collections.Generic;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections.Generic;
namespace PSDocs.Pipeline
{

Просмотреть файл

@ -1,4 +1,6 @@

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using PSDocs.Data;
using PSDocs.Models;
using PSDocs.Processor;

Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше