Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add docs uids #846

Merged
merged 1 commit into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/debugger-support.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.Debugger
---

## .NET for WebAssembly Debugger Support

Debugging is supported through the integration of a .NET Core CLI component, which acts as a static files server, as well as a debugger proxy for Chrome (other browsers are not supported).
Expand Down
3 changes: 3 additions & 0 deletions doc/deploy-and-publish.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
uid: UnoWasmBootstrap.Features.Publish
---

## Publishing the build results
The easiest way to publish the build results is to use the Visual Studio publish menu on your project. This will allow to use all the features provided by the standard experience, as described in the [Deploy to Azure App Service](https://docs.microsoft.com/en-us/visualstudio/deployment/quickstart-deploy-to-azure?view=vs-2017).
Expand Down
4 changes: 4 additions & 0 deletions doc/features-4gb.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.4gb
---

### 4GB memory support

The support for 4GB memory space is available by adding the following configuration:
Expand Down
4 changes: 4 additions & 0 deletions doc/features-additional-files.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.AdditionalFiles
---

### Index.html content override
The msbuild property `WasmShellIndexHtmlPath` can be used to specify the path of a project-specific `index.html` file.

Expand Down
4 changes: 4 additions & 0 deletions doc/features-dependency-management.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.DependencyManagement
---

### Dependency management
The Uno Bootstrapper uses RequireJS for dependency management, allowing for dependencies to be resolved in a stable manner.

Expand Down
3 changes: 3 additions & 0 deletions doc/features-embedded.mode.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
uid: UnoWasmBootstrap.Features.EmbeddedMode
---

### Browser Embedded mode

Expand Down
4 changes: 4 additions & 0 deletions doc/features-environment-variables.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.EnvironmentVariables
---


## Environment variables
Mono provides the ability to configure some features at initialization, such as logging or GC.
Expand Down
4 changes: 4 additions & 0 deletions doc/features-httprequestmessage-extensions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.HttpRequestExtensions
---

## Support for HttpRequestMessage Extensions
As of .NET 7, the BCL [does not provide a way](https://github.com/dotnet/runtime/issues/77904) to set the `fetch` API options for a `HttpRequestMessage`. This feature is provided as part of Blazor, which cannot be integrated into Uno Bootstrapper Applications at this time.

Expand Down
1 change: 1 addition & 0 deletions doc/features-interop.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
uid: Uno.Wasm.Bootstrap.JSInterop
---

## Interoperating with Javascript

The Uno boostrapper provides the ability to interoperate from and to Javascript from .NET.
Expand Down
4 changes: 4 additions & 0 deletions doc/features-linker-opts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.LinkerOpts
---

## Emscripten Linker optimizations flags

When building with AOT or using static linking of bitcode files, the emscripten linker step is enabled and runs optimizations on the generated code.
Expand Down
4 changes: 4 additions & 0 deletions doc/features-memory-corruption-troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.MemoryTroubleshooting
---

## Native memory troubleshooting

To enable native memory troubleshooting, it is possible to use [LLVM's sanitizer](https://emscripten.org/docs/debugging/Sanitizers.html) feature.
Expand Down
4 changes: 4 additions & 0 deletions doc/features-module-linking.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.ModuleLinking
---

### WebAssembly Module Linking support

#### Static Linking overview
Expand Down
4 changes: 4 additions & 0 deletions doc/features-node-js.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.NodeJS
---

### Node.js support

The bootstrapper supports having a project loaded as part of a node application. To do so:
Expand Down
4 changes: 4 additions & 0 deletions doc/features-nuget-package-overrides.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.PackageOverrides
---

### Nuget package runtime overrides
By default, when presented with an assembly present in both the runtime and a nuget package, the bootstrapper will favor the runtime's version of the assembly. This is generally required to avoid internal consistency errors with the runtime.

Expand Down
4 changes: 4 additions & 0 deletions doc/features-obfsucation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.Obfuscation
---

## Assemblies obfuscation

The Bootstrapper provides a way to obfuscate served assemblies in order to avoid incorrect flagging by anti-virus and firewalls.
Expand Down
4 changes: 4 additions & 0 deletions doc/features-pre-compression.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.PreCompression
---

### Pre-Compression support

Pre-compression has two modes:
Expand Down
4 changes: 4 additions & 0 deletions doc/features-prefetch.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.Prefetch
---

### Support for Content prefetching
The `WashShellGeneratePrefetchHeaders` controls the generation of `<link rel="prefetch" />` nodes in the index.html header.

Expand Down
4 changes: 3 additions & 1 deletion doc/features-pwa.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@

---
uid: UnoWasmBootstrap.Features.PWA
---

### Support for PWA Manifest File
A **Progressive Web App** manifest link definition can be added to the index.html file's head:
Expand Down
3 changes: 2 additions & 1 deletion doc/features-security.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
uid: Uno.Wasm.Bootstrap.Security
uid: Uno.Wasm.Bootstrap.Features.Security
---

# Security

## CSP Support
Expand Down
4 changes: 4 additions & 0 deletions doc/features-simd.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.Overview
---

## Support for SIMD

Starting from .NET 7, support for SIMD is available through the following property:
Expand Down
4 changes: 4 additions & 0 deletions doc/features-splash-screen.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.SplashScreen
---

## Splash screen customization

The default configuration for the bootstrapper is to show the Uno Platform logo. This can be changed, along with the background color and progress bar color by doing the following:
Expand Down
4 changes: 4 additions & 0 deletions doc/features-threading.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.Threading
---

## Support for WebAssembly Threads

Starting from .NET 7, experimental support for [WebAssembly threads](https://github.com/WebAssembly/threads/blob/master/proposals/threads/Overview.md) has been included. This support is provided by the boostrapper 7.0 and later, for interpreter and AOT modes. The following documentation explains how to enable threading.
Expand Down
4 changes: 4 additions & 0 deletions doc/features-version-checker.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.VersionChecker
---

# Uno.Wasm.VersionChecker

This is a tool to extract the version of _dotnet assemblies_ used on a Uno.UI application. Should also work with most applications built on _Uno Bootstrapper_.
Expand Down
4 changes: 4 additions & 0 deletions doc/linker-configuration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.LinkerConfig
---


## Linker configuration
The .NET tooling uses the [ILLinker](https://github.com/mono/linker/tree/master/), and can be configured using a linker directives file.
Expand Down
1 change: 1 addition & 0 deletions doc/runtime-execution-modes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
uid: Uno.Wasm.Bootstrap.Runtime.Execution
---

# Runtime Execution Modes

The mono for WebAssembly runtime provides three execution modes, Interpreter, AOT (Ahead of Time), and Mixed Mode Interpreter/AOT.
Expand Down
4 changes: 4 additions & 0 deletions doc/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Features.Troubleshooting
---

### Windows Long Path support
The bootstrapper supports Windows 10 long paths by default, but there may be cases where the `\\?\` [path format](https://web.archive.org/web/20160818035729/https://blogs.msdn.microsoft.com/jeremykuhne/2016/06/21/more-on-new-net-path-handling/) may not be supported.

Expand Down
4 changes: 4 additions & 0 deletions doc/using-the-bootstrapper.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
uid: UnoWasmBootstrap.Overview
---

Uno.Wasm.Bootstrap provides a simple way to package C# .NET code, and run it from a compatible browser environment.

It is a standalone .NET Web Assembly (Wasm) sdk bootstrapper taking the form of a nuget package.
Expand Down
Loading