-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add powershell
code fences where appropriate
#1511
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
powershell
code fences where appropriate
We do this generally as we see it. Unfortunately, the syntax highlighting doesn't come out too well in examples like yours where there's output, so that might be why you're not seeing it in certain places. |
Shouldn't the Example below: Output as below: Get-Command -Name Clear-Host
|
that's what I have in the Style Guide, yeah. |
@chenrylee @zjalexander Now that we have moved the documentation to docs.microsoft.com, we can leave the |
Hi @sdwheeler, Its great to know that it omit |
@kiazhi |
So as per the style guide:
The style guide does NOT have the following: ```powershell Given how docs is rendering it, we do prefer that and I will update the style guide. However, instead of ```text we can use ```output which Docs recommends. We should fix this as we touch individual articles. |
PowerShell/platyPS#294 there is also a related PlatyPS ask to insert this automatically. |
@zjalexander Is this up for grabs? I can take this and run through the MDs and submit a PR |
@MSAdministrator This is up for grabs. Please avoid the About_ topics. These were recently reformatted to meet the requirements of changes to our tool chain. Also please read the recently updated Contributors Guide, especially https://github.com/PowerShell/PowerShell-Docs/blob/staging/contributing/FORMATTING-CODE.md. Thanks for helping out. |
In progress, I plan doing PowerShell 3.0 to 6. |
@sdwheeler No problem! Quick question, should I commit each MD and then PR a branch for each version? Or commit each MD and do 1 big ol' PR? or something else? :) Almost done with 3.0 |
Minimize the commits but number of commits is not that important. Do a branch for each topic. My suggestion is this - say you are updating Get-Content.md. Update all versions (3/4/5/5.1/6) of Get-Content.md. The updated files can be one or more commits to your branch. PR that branch. See #1969 for an example PR like this. |
@sdwheeler Will do! Thanks for the clarification! |
@sdwheeler An example of my changes across all the docs is in #2070 |
The Powershell docs have been migrated to new place, and now they all became good-look.
I have read some articles, and found the code blocks are not highlighted.
Indeed, this feature is supported.
I picked a block in an article, it's the original style:
if we add the language tag, it shows:
Yes, just add
powershell
following the first 3-grave mark.Can you please update all code blocks within the articles?
The text was updated successfully, but these errors were encountered: