DocFX
PowerShell-Docs
Our great sponsors
DocFX | PowerShell-Docs | |
---|---|---|
18 | 10 | |
3,885 | 1,884 | |
1.7% | 1.6% | |
9.8 | 9.6 | |
3 days ago | 4 days ago | |
C# | PowerShell | |
MIT License | Creative Commons Attribution 4.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
DocFX
-
TSDocs.dev: type docs for any JavaScript library
This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool?
https://docs.oracle.com/javase/8/docs/technotes/tools/window...
https://dotnet.github.io/docfx/
I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated by the above tools to discover new API's that suit my needs, diving into the actual code using a good decompiler is still my first move, as it is often cheaper than seeking out the documentation online, and it will show me the actual implementation as well. So in my opinion there is no shame in looking inside the declaration files!
-
Use Case Driven Development with Low-Code
Tools like DocFx provide the ability to display the programmable functions in HTML pages. They are used with the following commands in the docfx folder:
-
Anybody know if there's a library for the doc engine that MS Docs/Learn uses?
AFAIK they use https://github.com/dotnet/docfx which can be too heavy for your case. We use mdBook for internal documentation (plain .md with mermaid plugin) and then serve it at docs.yourdevenv.com.
- Is there a simple way to auto-generate a wiki / documentation for project code that pulls from comments or <summary> tags?
-
What the latest tool to generate website docs from /// summary comments?
DocFX is a nice solution.
-
How to build a solution like docs.microsoft.com
It uses DocFX
-
Comments in Javascript
Some of the standard and well-maintained Tools for Comments are JSDoc for Javascript, DocFx for .NET, and JavaDoc for Java.
-
What Does Microsoft Use to Create their KB Articles?
Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/
-
Library / Codebase Documentation - Multiple aggregated libraries - How to create? DocFx does not support this?
We would really prefer to use a somewhat generic pre-made tool for this (such as DocFX) compared to rolling our own solution. We can roll our own solution... But would prefer not to so that we can minimize development and maintenance overhead.
PowerShell-Docs
- Show HN: Query Your Sheets with SheetSQL
-
TIL about --%
--% is a half-baked solution and has various inherent issues. It should not be relied upon if alternative solutions exist.
-
How to build a solution like docs.microsoft.com
They seem to have an internal system that is triggered by commits on the main branch on those repositories that contain docs. For example, if you look at https://github.com/MicrosoftDocs/PowerShell-Docs, and click on the commit checks for the latest main commit (green checkmark next to the commit), there is one check "OpenPublishing.Build" that leads to the report of where the files were uploaded: https://opbuilduserstoragepublic.blob.core.windows.net/report/2022%5C5%5C5%5C6ff7e8c3-dfc6-3ebd-da5a-d5e2ff43de8f%5CPullRequest%5C202205052157488348-8793%5Cworkflow_report.html?sv=2021-04-10&se=2022-06-05T21%3A59%3A48Z&sr=b&sp=r&sig=VsulIs3Vw8QappOaWIin6%2FqLJN5M99%2FATZiOWFF3k0U%3D
-
PS v7 Get-Service -ComputerName is not supported
This might be useful: https://github.com/MicrosoftDocs/PowerShell-Docs/issues/5665
-
Start-Job with alt creds fails, but only when run as scheduled task
Then I found this. But there is no doc in here related to my issue.
-
How to download/save multiple pages from a docs.microsoft.com site for educational purposes?
Yes on the main page -- Click on the Green Code Button, then click Download Zip. It will work better if you have a copy of the GitHub desktop client, but its not technically necessary.
-
Support just requested an IP address for an oven
Sorry to break it to you, but Preheat is not an approved Powershell verb :(
-
A quick explanation, please?
This issue explains the reason. Get-Service was using DCOM, which has been removed.
- What kind of permissions are required to query and work with remote desktop sessions through WinRM
What are some alternatives?
Sandcastle - Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.
PSWritePDF - PowerShell Module to create, edit, split, merge PDF files on Windows / Linux and MacOS
MkDocs - Project documentation with Markdown.
DalamudPlugins - This repository hosts plugins for XIVLauncher/Dalamud
Swashbuckle - Seamlessly adds a swagger to WebApi projects!
Mailozaurr - Mailozaurr is a PowerShell module that aims to provide SMTP, POP3, IMAP and probably some other ways to interact with Email. Underneath it uses MimeKit and MailKit libraries written by Jeffrey Stedfast.
DocNet - Your friendly static documentation generator, using markdown files to build the content.
snek - PowerShell wrapper around Python for .NET to invoke Python from PowerShell
SharpDox
Polaris - A cross-platform, minimalist web framework for PowerShell
F# Formatting - F# tools for generating documentation (Markdown processor and F# code formatter)
PSWinDocumentation - PowerShell Module that creates Word/Excel/SQL documentation from Active Directory (AD), AWS, Office 365 and others. It's a work in progress!