Skip to content

atskas/HyperSharp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HyperSharp

License Status

Logo

A lightweight, modular C# to HTML converter library which takes raw C# and converts it to well-structured HTML.

Getting started

Requirements

  • .NET 6.0 or later

Installation

  1. Clone the repository:
git clone https://github.com/atskas/HyperSharp
cd HyperSharp
  1. Build the library:
dotnet build HyperSharp.Library/HyperSharp.Library.csproj

This produces HyperSharp.Library.dll in the bin folder.

  1. Reference the library in your project:
dotnet add path/to/Project.csproj reference HyperSharp.Library/HyperSharp.Library.csproj

Usage

Start working with HyperSharp by creating a new HtmlDocument:

private static HtmlDocument Document = new();

Use its methods to define HTML structure and elements programmatically.

Configuration

You can customize the output by setting the following properties:

  • OutputFileName - Name of the generated HTML file (default: output.html)
  • OutputPath - Directory where the output file is saved (default: Documents/HyperSharp_Output)
  • UserCssPath - Optional path to a custom CSS file or directory for styling the generated HTML

You can run the demo project to check out HyperSharp's possibilities.

dotnet run --project HyperSharp.Testing/HyperSharp.Testing.csproj

See GitHub's contribution guide if you’d like to help out!

Releases

No releases published

Packages

No packages published