Skip to content

Commit 57fe97e

Browse files
codecov-releasercodecov-releaser
committed
meta: Update docs
1 parent 0112a45 commit 57fe97e

32 files changed

Lines changed: 188 additions & 142 deletions

‎assets/highlight.css‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55
--dark-hl-1: #D4D4D4;
66
--light-hl-2: #A31515;
77
--dark-hl-2: #CE9178;
8-
--light-hl-3: #0000FF;
9-
--dark-hl-3: #569CD6;
10-
--light-hl-4: #008000;
11-
--dark-hl-4: #6A9955;
12-
--light-hl-5: #0070C1;
13-
--dark-hl-5: #4FC1FF;
14-
--light-hl-6: #001080;
15-
--dark-hl-6: #9CDCFE;
16-
--light-hl-7: #098658;
17-
--dark-hl-7: #B5CEA8;
18-
--light-hl-8: #AF00DB;
19-
--dark-hl-8: #C586C0;
8+
--light-hl-3: #008000;
9+
--dark-hl-3: #6A9955;
10+
--light-hl-4: #AF00DB;
11+
--dark-hl-4: #C586C0;
12+
--light-hl-5: #001080;
13+
--dark-hl-5: #9CDCFE;
14+
--light-hl-6: #0000FF;
15+
--dark-hl-6: #569CD6;
16+
--light-hl-7: #0070C1;
17+
--dark-hl-7: #4FC1FF;
18+
--light-hl-8: #098658;
19+
--dark-hl-8: #B5CEA8;
2020
--light-hl-9: #267F99;
2121
--dark-hl-9: #4EC9B0;
2222
--light-code-background: #FFFFFF;

‎assets/navigation.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎assets/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎functions/_codecov_astro_plugin.default.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | Codecov JavaScript Bundler Plugins</title><meta name="description" content="Documentation for Codecov JavaScript Bundler Plugins"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Codecov JavaScript Bundler Plugins</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Codecov JavaScript Bundler Plugins</a></li><li><a href="../modules/_codecov_astro_plugin.html">@codecov/astro-plugin</a></li><li><a href="_codecov_astro_plugin.default.html">default</a></li></ul><h1>Function default</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="default" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AstroIntegration</span><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Details for the Codecov Astro plugin.</p>
2+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/_codecov_bundle_analyzer.index.Options.html" class="tsd-signature-type tsd-kind-interface">Options</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AstroIntegration</span></h4><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-typescript"><span class="hl-3">// astro.config.mjs</span><br/><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">defineConfig</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&quot;astro/config&quot;</span><span class="hl-1">;</span><br/><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">codecovAstroPlugin</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@codecov/astro-plugin&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">// https://astro.build/config</span><br/><span class="hl-4">export</span><span class="hl-1"> </span><span class="hl-4">default</span><span class="hl-1"> </span><span class="hl-0">defineConfig</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-3">// other config settings</span><br/><span class="hl-1"> </span><span class="hl-5">integrations:</span><span class="hl-1"> [</span><br/><span class="hl-1"> </span><span class="hl-3">// place this after all other integrations</span><br/><span class="hl-1"> </span><span class="hl-0">codecovAstroPlugin</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-5">enableBundleAnalysis:</span><span class="hl-1"> </span><span class="hl-6">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">bundleName:</span><span class="hl-1"> </span><span class="hl-2">&quot;example-astro-bundle&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">gitService:</span><span class="hl-1"> </span><span class="hl-2">&quot;github&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> }),</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1">});</span>
3+
</code><button>Copy</button></pre>
4+
<h4>See</h4><p><a href="../interfaces/_codecov_bundler_plugin_core.Options.html" class="tsd-kind-interface">Options</a> for list of options.</p>
5+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/codecov/codecov-javascript-bundler-plugins/blob/6c4a0ce/packages/astro-plugin/src/index.ts#L78">index.ts:78</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Codecov JavaScript Bundler Plugins</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>

0 commit comments

Comments
 (0)