DocFX
rust
DocFX | rust | |
---|---|---|
18 | 2,683 | |
3,889 | 93,041 | |
0.9% | 1.2% | |
9.8 | 10.0 | |
3 days ago | 6 days ago | |
C# | Rust | |
MIT License | GNU General Public License v3.0 or later |
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.
rust
-
Create a Custom GitHub Action in Rust
If you haven't dipped your touch-typing fingers into Rust yet, you really owe it to yourself. Rust is a modern programming language with features that make it suitable not only for systems programming -- its original purpose, but just about any other environment, too; there are frameworks that let your build web services, web applications including user interfaces, software for embedded devices, machine learning solutions, and of course, command-line tools. Since a custom GitHub Action is essentially a command-line tool that interacts with the system through files and environment variables, Rust is perfectly suited for that as well.
-
Why Does Windows Use Backslash as Path Separator?
Here's an example of someone citing a disagreement between CRT and shell32:
https://github.com/rust-lang/rust/issues/44650
This in addition to the Rust CVE mentioned elsewhere in the thread which was rooted in this issue:
https://blog.rust-lang.org/2024/04/09/cve-2024-24576.html
Here are some quick programs to test contrasting approaches. I don't have examples of inputs where they parse differently on hand right now, but I know they exist. This was also a problem that was frequently discussed internally when I worked at MSFT.
#include
-
I hate Rust (programming language)
> instead of choosing a certain numbered version of the random library (if I remember correctly) I let cargo download the latest version which had a completely different API.
Yeah, they didn't follow the instructions and got burned. I still think that multiple things went wrong simultaneously for that experience. I wonder if more prevalent uses of `#[doc(alias = "name")]` being leveraged by https://github.com/rust-lang/rust/pull/120730 (which now that I check only accounts for methods and not functions, I should get on that!) so that when changing APIs around people at least get a slightly better experience.
- Rust Weird Exprs
- Critical safety flaw found in Rust on Windows (CVE-2024-24576)
-
Unformat Rust code into perfect rectangles
Almost fixed the compiler: https://github.com/rust-lang/rust/pull/123325
-
Implement React v18 from Scratch Using WASM and Rust - [1] Build the Project
Rust: A secure, efficient, and modern programming language (omitting ten thousand words). You can simply follow the installation instructions provided on the official website.
-
Show HN: Fancy-ANSI – Small JavaScript library for converting ANSI to HTML
Recently did something similar in Rust but for generating SVGs. We've adopted it for snapshot testing of cargo and rustc's output. Don't have a good PR handy for showing Github's rendering of changes in the SVG (text, side-by-side, swiping) but https://github.com/rust-lang/rust/pull/121877/files has newly added SVGs.
To see what is supported, see the screenshot in the docs: https://docs.rs/anstyle-svg/latest/anstyle_svg/
-
Upgrading Hundreds of Kubernetes Clusters
We strongly believe in Rust as a powerful language for building production-grade software, especially for systems like ours that run alongside Kubernetes.
-
What Are Const Generics and How Are They Used in Rust?
The above Assert<{N % 2 == 1}> requires #![feature(generic_const_exprs)] and the nightly toolchain. See https://github.com/rust-lang/rust/issues/76560 for more info.
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.
carbon-lang - Carbon Language's main repository: documents, design, implementation, and related tools. (NOTE: Carbon Language is experimental; see README)
MkDocs - Project documentation with Markdown.
zig - General-purpose programming language and toolchain for maintaining robust, optimal, and reusable software.
Swashbuckle - Seamlessly adds a swagger to WebApi projects!
Nim - Nim is a statically typed compiled systems programming language. It combines successful concepts from mature languages like Python, Ada and Modula. Its design focuses on efficiency, expressiveness, and elegance (in that order of priority).
DocNet - Your friendly static documentation generator, using markdown files to build the content.
Odin - Odin Programming Language
SharpDox
Elixir - Elixir is a dynamic, functional language for building scalable and maintainable applications
F# Formatting - F# tools for generating documentation (Markdown processor and F# code formatter)
Rustup - The Rust toolchain installer