Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history
Deploy website version based on 1548778900bda0af6811b22a691633af6c0a3856
  • Loading branch information
rnbot committed Aug 27, 2024
1 parent e15ff2c commit 721d887
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/NuGet.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,17 @@
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/react-native-windows-samples/blob/main/docs/nuget.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Using Microsoft.ReactNative NuGet packages</h1></header><article><div><span><blockquote>
<p><strong>This documentation and the underlying platform code is a work in progress.</strong></p>
</blockquote>
<p>When creating a new project in <a href="/react-native-windows/docs/getting-started">Get Started with Windows</a>, the type of template selected for the <a href="/react-native-windows/docs/init-windows-cli">init-windows command</a> will determine whether or not the project will built against the <code>react-native-windows</code> source or the pre-built NuGet packages.</p>
<p>Traditionally, the default for React Native Windows has been to build all code from source. This includes building all the code shipped by the team in the npm package from source. The amount of code is quite large and takes both a long time to build as well as requiring a high-performance computer. Some configurations have problems building this code with only 8 GB of memory. Especially if you are used to working only with managed code, this can be a big surprise.</p>
<p>Starting with the (currently experimental) New Architecture (i.e. Fabric) app and module projects, React Native Windows will default to consuming pre-built binary NuGet packages instead of requiring you to compile everything yourself.</p>
<p>The benefit of using NuGet packages is that you get improved compilation times for your Windows project and can develop on a less powerful computer. This will also translate into a smoother update experience for newer versions of <code>react-native-windows</code>.</p>
<p>When creating a new project in <a href="/react-native-windows/docs/getting-started">Get Started with Windows</a>, the type of template selected for the <a href="/react-native-windows/docs/init-windows-cli">init-windows command</a> will determine whether or not the project will built against the <code>react-native-windows</code> source or the pre-built NuGet packages.</p>
<blockquote>
<p><strong>Note on new projects:</strong> Building from source will remain the default for new Old Architecture projects. This is because there are known compatibility issues with <a href="/react-native-windows/docs/supported-community-modules">community modules</a>, as they often still rely on building the shared code from source, making the parallel use of NuGets problematic. Newly created New Architecture projects will build using the NuGets starting with <code>[email protected]</code>.</p>
</blockquote>
<blockquote>
<p><strong>Note on existing projects:</strong> Previously exposed methods (see below) for building Old Architecture projects against NuGets were experimental and are being deprecated, and therefore should not be used. If you're in the process of upgrading an existing Old Architecture project that <em>did</em> use those experimental methods, the <a href="/react-native-windows/docs/init-windows-cli">init-windows command</a> will try to respect that setting until the methods are formally deprecated and removed.</p>
</blockquote>
<h1><a class="anchor" aria-hidden="true" id="enabling-nugets-for-old-architecture-projects-not-recommended"></a><a href="#enabling-nugets-for-old-architecture-projects-not-recommended" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Enabling NuGets for Old Architecture Projects (Not Recommended)</h1>
<h2><a class="anchor" aria-hidden="true" id="enabling-nugets-for-old-architecture-projects-not-recommended"></a><a href="#enabling-nugets-for-old-architecture-projects-not-recommended" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Enabling NuGets for Old Architecture Projects (Not Recommended)</h2>
<p>The formerly recommended <a href="https://microsoft.github.io/react-native-windows/init-cli">React Native Windows Init CLI</a> still supports an <code>--experimentalNuGetDependency true</code> flag to set up an Old Architecture project which uses NuGet packages, but that command will not work to create/upgrade RNW projects after RNW 0.75, and use of that flag remains strictly experimental.</p>
<p>If you have an existing Old Architecture project, the steps below may help you modify your RNW Old Architecture project so you can consume the RNW NuGet packages.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-39-tab-40" class="nav-link active" data-group="group_39" data-tab="tab-group-39-content-40">C# projects</div><div id="tab-group-39-tab-41" class="nav-link" data-group="group_39" data-tab="tab-group-39-content-41">C++ projects</div></div><div class="tab-content"><div id="tab-group-39-content-40" class="tab-pane active" data-group="group_39" tabindex="-1"><div><span><ol>
Expand Down Expand Up @@ -113,4 +113,4 @@ <h1><a class="anchor" aria-hidden="true" id="enabling-nugets-for-old-architectur
</ol></li>
</ol>
</span></div></div></div></div>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/react-native-windows/docs/hermes"><span class="arrow-prev"></span><span class="function-name-prevnext">Hermes on Windows + macOS</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><div><h5>React Native Docs</h5><a href="https://reactnative.dev/docs/getting-started">Getting Started</a><a href="https://reactnative.dev/docs/tutorial">Tutorial</a><a href="https://reactnative.dev/docs/components-and-apis">Components and APIs</a><a href="https://reactnative.dev/docs/more-resources">More Resources</a></div><div><h5>React Native for Windows + macOS Docs</h5><div style="color:white;font-weight:500;font-size:16px"><a href="/react-native-windows/docs/getting-started">Get Started with Windows</a></div><div style="color:white;font-weight:500;font-size:16px"><a href="/react-native-windows/docs/rnm-getting-started"> Get Started with macOS</a></div><a href="/react-native-windows/docs/parity-status">React Native Windows Components and APIs</a><a href="/react-native-windows/docs/native-modules">Native Modules</a><a href="/react-native-windows/docs/view-managers">Native UI Components</a></div><div><h5>Connect With Us On</h5><a href="https://devblogs.microsoft.com/react-native/">Blog</a><a href="https://twitter.com/ReactNativeMSFT" target="_blank">Twitter</a><a href="https://github.com/microsoft/react-native-windows" target="_blank">GitHub</a><a href="https://github.com/microsoft/react-native-windows-samples/tree/main/samples" target="_blank">Samples</a></div></section></footer></div></body></html>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/react-native-windows/docs/hermes"><span class="arrow-prev"></span><span class="function-name-prevnext">Hermes on Windows + macOS</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#enabling-nugets-for-old-architecture-projects-not-recommended">Enabling NuGets for Old Architecture Projects (Not Recommended)</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><div><h5>React Native Docs</h5><a href="https://reactnative.dev/docs/getting-started">Getting Started</a><a href="https://reactnative.dev/docs/tutorial">Tutorial</a><a href="https://reactnative.dev/docs/components-and-apis">Components and APIs</a><a href="https://reactnative.dev/docs/more-resources">More Resources</a></div><div><h5>React Native for Windows + macOS Docs</h5><div style="color:white;font-weight:500;font-size:16px"><a href="/react-native-windows/docs/getting-started">Get Started with Windows</a></div><div style="color:white;font-weight:500;font-size:16px"><a href="/react-native-windows/docs/rnm-getting-started"> Get Started with macOS</a></div><a href="/react-native-windows/docs/parity-status">React Native Windows Components and APIs</a><a href="/react-native-windows/docs/native-modules">Native Modules</a><a href="/react-native-windows/docs/view-managers">Native UI Components</a></div><div><h5>Connect With Us On</h5><a href="https://devblogs.microsoft.com/react-native/">Blog</a><a href="https://twitter.com/ReactNativeMSFT" target="_blank">Twitter</a><a href="https://github.com/microsoft/react-native-windows" target="_blank">GitHub</a><a href="https://github.com/microsoft/react-native-windows-samples/tree/main/samples" target="_blank">Samples</a></div></section></footer></div></body></html>
6 changes: 3 additions & 3 deletions docs/NuGet/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,17 @@
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/microsoft/react-native-windows-samples/blob/main/docs/nuget.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Using Microsoft.ReactNative NuGet packages</h1></header><article><div><span><blockquote>
<p><strong>This documentation and the underlying platform code is a work in progress.</strong></p>
</blockquote>
<p>When creating a new project in <a href="/react-native-windows/docs/getting-started">Get Started with Windows</a>, the type of template selected for the <a href="/react-native-windows/docs/init-windows-cli">init-windows command</a> will determine whether or not the project will built against the <code>react-native-windows</code> source or the pre-built NuGet packages.</p>
<p>Traditionally, the default for React Native Windows has been to build all code from source. This includes building all the code shipped by the team in the npm package from source. The amount of code is quite large and takes both a long time to build as well as requiring a high-performance computer. Some configurations have problems building this code with only 8 GB of memory. Especially if you are used to working only with managed code, this can be a big surprise.</p>
<p>Starting with the (currently experimental) New Architecture (i.e. Fabric) app and module projects, React Native Windows will default to consuming pre-built binary NuGet packages instead of requiring you to compile everything yourself.</p>
<p>The benefit of using NuGet packages is that you get improved compilation times for your Windows project and can develop on a less powerful computer. This will also translate into a smoother update experience for newer versions of <code>react-native-windows</code>.</p>
<p>When creating a new project in <a href="/react-native-windows/docs/getting-started">Get Started with Windows</a>, the type of template selected for the <a href="/react-native-windows/docs/init-windows-cli">init-windows command</a> will determine whether or not the project will built against the <code>react-native-windows</code> source or the pre-built NuGet packages.</p>
<blockquote>
<p><strong>Note on new projects:</strong> Building from source will remain the default for new Old Architecture projects. This is because there are known compatibility issues with <a href="/react-native-windows/docs/supported-community-modules">community modules</a>, as they often still rely on building the shared code from source, making the parallel use of NuGets problematic. Newly created New Architecture projects will build using the NuGets starting with <code>[email protected]</code>.</p>
</blockquote>
<blockquote>
<p><strong>Note on existing projects:</strong> Previously exposed methods (see below) for building Old Architecture projects against NuGets were experimental and are being deprecated, and therefore should not be used. If you're in the process of upgrading an existing Old Architecture project that <em>did</em> use those experimental methods, the <a href="/react-native-windows/docs/init-windows-cli">init-windows command</a> will try to respect that setting until the methods are formally deprecated and removed.</p>
</blockquote>
<h1><a class="anchor" aria-hidden="true" id="enabling-nugets-for-old-architecture-projects-not-recommended"></a><a href="#enabling-nugets-for-old-architecture-projects-not-recommended" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Enabling NuGets for Old Architecture Projects (Not Recommended)</h1>
<h2><a class="anchor" aria-hidden="true" id="enabling-nugets-for-old-architecture-projects-not-recommended"></a><a href="#enabling-nugets-for-old-architecture-projects-not-recommended" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Enabling NuGets for Old Architecture Projects (Not Recommended)</h2>
<p>The formerly recommended <a href="https://microsoft.github.io/react-native-windows/init-cli">React Native Windows Init CLI</a> still supports an <code>--experimentalNuGetDependency true</code> flag to set up an Old Architecture project which uses NuGet packages, but that command will not work to create/upgrade RNW projects after RNW 0.75, and use of that flag remains strictly experimental.</p>
<p>If you have an existing Old Architecture project, the steps below may help you modify your RNW Old Architecture project so you can consume the RNW NuGet packages.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-39-tab-40" class="nav-link active" data-group="group_39" data-tab="tab-group-39-content-40">C# projects</div><div id="tab-group-39-tab-41" class="nav-link" data-group="group_39" data-tab="tab-group-39-content-41">C++ projects</div></div><div class="tab-content"><div id="tab-group-39-content-40" class="tab-pane active" data-group="group_39" tabindex="-1"><div><span><ol>
Expand Down Expand Up @@ -113,4 +113,4 @@ <h1><a class="anchor" aria-hidden="true" id="enabling-nugets-for-old-architectur
</ol></li>
</ol>
</span></div></div></div></div>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/react-native-windows/docs/hermes"><span class="arrow-prev"></span><span class="function-name-prevnext">Hermes on Windows + macOS</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><div><h5>React Native Docs</h5><a href="https://reactnative.dev/docs/getting-started">Getting Started</a><a href="https://reactnative.dev/docs/tutorial">Tutorial</a><a href="https://reactnative.dev/docs/components-and-apis">Components and APIs</a><a href="https://reactnative.dev/docs/more-resources">More Resources</a></div><div><h5>React Native for Windows + macOS Docs</h5><div style="color:white;font-weight:500;font-size:16px"><a href="/react-native-windows/docs/getting-started">Get Started with Windows</a></div><div style="color:white;font-weight:500;font-size:16px"><a href="/react-native-windows/docs/rnm-getting-started"> Get Started with macOS</a></div><a href="/react-native-windows/docs/parity-status">React Native Windows Components and APIs</a><a href="/react-native-windows/docs/native-modules">Native Modules</a><a href="/react-native-windows/docs/view-managers">Native UI Components</a></div><div><h5>Connect With Us On</h5><a href="https://devblogs.microsoft.com/react-native/">Blog</a><a href="https://twitter.com/ReactNativeMSFT" target="_blank">Twitter</a><a href="https://github.com/microsoft/react-native-windows" target="_blank">GitHub</a><a href="https://github.com/microsoft/react-native-windows-samples/tree/main/samples" target="_blank">Samples</a></div></section></footer></div></body></html>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/react-native-windows/docs/hermes"><span class="arrow-prev"></span><span class="function-name-prevnext">Hermes on Windows + macOS</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#enabling-nugets-for-old-architecture-projects-not-recommended">Enabling NuGets for Old Architecture Projects (Not Recommended)</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><div><h5>React Native Docs</h5><a href="https://reactnative.dev/docs/getting-started">Getting Started</a><a href="https://reactnative.dev/docs/tutorial">Tutorial</a><a href="https://reactnative.dev/docs/components-and-apis">Components and APIs</a><a href="https://reactnative.dev/docs/more-resources">More Resources</a></div><div><h5>React Native for Windows + macOS Docs</h5><div style="color:white;font-weight:500;font-size:16px"><a href="/react-native-windows/docs/getting-started">Get Started with Windows</a></div><div style="color:white;font-weight:500;font-size:16px"><a href="/react-native-windows/docs/rnm-getting-started"> Get Started with macOS</a></div><a href="/react-native-windows/docs/parity-status">React Native Windows Components and APIs</a><a href="/react-native-windows/docs/native-modules">Native Modules</a><a href="/react-native-windows/docs/view-managers">Native UI Components</a></div><div><h5>Connect With Us On</h5><a href="https://devblogs.microsoft.com/react-native/">Blog</a><a href="https://twitter.com/ReactNativeMSFT" target="_blank">Twitter</a><a href="https://github.com/microsoft/react-native-windows" target="_blank">GitHub</a><a href="https://github.com/microsoft/react-native-windows-samples/tree/main/samples" target="_blank">Samples</a></div></section></footer></div></body></html>
Loading

0 comments on commit 721d887

Please sign in to comment.