Create a new Umbraco 10+ package

Package Details

Alias* Specify the alias of your package. The alias will be used for the assembly name as well as the package's ID on NuGet.

If not prefixing the alias with a company name or your own name, it's recommended using Umbraco.Community.YourPackageName.

Title Enter a friendly title or name of your package.

Description Enter a short description about your package. This will be part of the information shown for your package on nuget.org.

Version Specify the version of your package. For packages that are still work in progress, you can specify something like 0.0.1 or 1.0.0-alpha001.

Company Specify the name of your company. This will be part of the information embedded in the generated DLL when you're building your package.

Authors Specify your name - or the names of any additional authors of the package. This will be part of the information embedded in the generated DLL when you're building your package, and part of the information shown on nuget.org.

Tags Specify a handful of tags that describe your package. These tags will be used for NuGet package.

Project URL Specify the URL to the website for your package. If you don't have a website, this could also be the URL to the repository of your code (eg. on GitHub).

Repository URL Specify the URL to repository of your code (eg. on GitHub).

Package Icon Specify the logo or icon for your package. This will be used as the icon for the NuGet package.

License

License Select the license of your package. Currently only MIT is supported.

License Holder Select the name that will be shown in the generated license file.

License Holder URL If specified, the name in the generated license will a clickable link to this URL.

Target Frameworks

.NET 6 Umbraco 10 uses .NET 6, so if you're targeting Umbraco 10, this is a must.

.NET 7 If your target specifically targets Umbraco 11, you should select .NET 7. If your package targets both Umbraco 10 and 11, .NET 7 is not a must, as you will be able to use .NET 6 packages with both Umbraco 10 and 11.

Language Features

Enable nullable reference types Select whether nullable references should be enabled for your package. This is recommended for improved code analysis in C#.

Razor Class Library Select whether your package should be a Razor Class Library. This determines how assets are included in your package and consumed by other projects, and is the recommended approach for Umbraco 10+.

.editorconfig Select whether an .editorconfig file should be included in the generated Visual Studio solution.

Umbraco

Version Specify the Umbraco version or version range that you package will target. This will be used for NuGet adding dependencies for Umbraco.

If left blank, your package will support being installed projects running all version of Umbraco 10 and 11.

Package Manifest Select what type of package manifest that should be included in your package.

Notice that Umbraco 10 doesn't support virtual package.manifest files inside a Razor Class Library.

Allow package telemetry Select whether your package allows Umbraco to save telemetry about your package.

Add example assets Select whether the generated project should contain an example Angular controller (.js) as well as an example stylesheet (.css).

Dependencies

{{dependency.name}} ({{dependency.version}}) {{dependency.description}}

Documentation

Build XML Documentation When enabled, a {{vm.options.alias}}.xml file will be part of the build for your package. This package will then add improved intellisense for developers using your package in Visual Studio or similar.

Notice that you should add XML documentation to your C# classes, properties, methods etc. - otherwise the {{vm.options.alias}}.xml will be close to empty.