Oakrey.Applications.Help 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Oakrey.Applications.Help --version 1.0.0
                    


                    

                
NuGet\Install-Package Oakrey.Applications.Help -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Oakrey.Applications.Help" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Oakrey.Applications.Help" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Oakrey.Applications.Help" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Oakrey.Applications.Help --version 1.0.0
                    


                    

                
#r "nuget: Oakrey.Applications.Help, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=Oakrey.Applications.Help&version=1.0.0
                    


                            Install Oakrey.Applications.Help as a Cake Addin
                        

                    

                
#tool nuget:?package=Oakrey.Applications.Help&version=1.0.0
                    


                            Install Oakrey.Applications.Help as a Cake Tool

Oakrey.Applications.Help

The "Help" project is a .NET 8 library designed to provide a structured and interactive help system for applications. It enables the loading, navigation, and display of help content, particularly Markdown files, in a user-friendly manner.

Features

Help Content Management:

Loads help content from a specified directory using HelpService. Supports hierarchical organization of help files.

Markdown File Support:

Displays Markdown files as the primary format for help content. Provides navigation between Markdown files.

ViewModel Integration:

HelpViewModel facilitates binding help content to UI elements. Supports navigation history (forward and backward) for help content.

File System Integration:

Uses FileSystemItem and related classes to represent files and folders in the help directory.

Extensibility:

Implements IHelpService for dependency injection and testability.

Logging:

Integrated with Oakrey.Log for logging service operations.

Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

  1. Open your project in Visual Studio.
  2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
  3. Search for Oakrey.Applications.Help and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Applications.Help

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Applications.Help

Requirements

  • .NET 8 or higher

Project Information

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Product Compatible and additional computed target framework versions.
.NET net8.0-windows7.0 is compatible.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 191 4/17/2025