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

📘 DOC: Missing docs on environment variable usages #873

Closed
stramel opened this issue Jul 26, 2021 · 3 comments
Closed

📘 DOC: Missing docs on environment variable usages #873

stramel opened this issue Jul 26, 2021 · 3 comments

Comments

@stramel
Copy link
Contributor

stramel commented Jul 26, 2021

Currently, there is no documentation around how to use environment variables within Astro and nothing noting the limitation of client-side usage.

Currently, SNOWPACK_PUBLIC_ is the required prefix for client-side usage.

Side Question: Should this be aliased to ASTRO_PUBLIC?

@markpinero
Copy link
Contributor

There is documentation but it's currently not linked to on the docs site: https://github.com/snowpackjs/astro/blob/main/examples/snowpack/src/pages/reference/environment-variables.md

@drwpow
Copy link
Member

drwpow commented Aug 19, 2021

+1 to this!

@drwpow drwpow added this to Accepted in 📘 Documentation Tracker Aug 19, 2021
@FredKSchott FredKSchott moved this from Accepted to TODO in 📘 Documentation Tracker Sep 1, 2021
AsyncBanana added a commit to AsyncBanana/astro that referenced this issue Oct 17, 2021
AsyncBanana added a commit to AsyncBanana/astro that referenced this issue Oct 18, 2021
drwpow pushed a commit that referenced this issue Oct 20, 2021
* Added environment variables docs (Closes #873)

* Fixed prefix
drwpow pushed a commit that referenced this issue Oct 22, 2021
* Added environment variables docs (Closes #873)

* Fixed prefix
📘 Documentation Tracker automation moved this from TODO to Completed Oct 29, 2021
@stramel
Copy link
Contributor Author

stramel commented Oct 30, 2021

Thanks! 🙏

SiriousHunter pushed a commit to SiriousHunter/astro that referenced this issue Feb 3, 2023
* make astro-root uids unique

* Move Astro to Vite

* Update tests

* More test improvements

* fred fixes

* Update compiler, improve tests

* Fix runtime, improve code frame

* Add Markdown support

* Tycho fixes

* Fred fixes part 2

* Throw Error for WIP Features

* Improve testing suite

* Allow users to pass config to Vite

* Fix npm install (withastro#1407)

* Automate publish on merge (withastro#1408)

* Add NPM_TOKEN to publish script (withastro#1409)

* Create .npmrc

* Clean up astro deps (withastro#1411)

* Use new renderers (withastro#1412)

* feat: update compiler (withastro#1421)

* Try mocha/chai test runners (withastro#1418)

* Try mocha/chai test runners

* Disable failing smoke test for now

Will revert when next can build docs

* Enable mocha in parallel mode

* Remove warning

* Update docs

* Fix Windows bug

* Fix internal imports

* Fix styles

* Fix CI release on merge to next (withastro#1427)

* Fix logger locale parsing (withastro#1439)

* fix(logger): locale parsing
* Fixed issue of compiler crash when "c" locale was encountered
* Return default locale if parsed locale is less than 2 chars long

* chore: add changeset

* Apply changes from withastro#1387

* Add back in support for children (withastro#1486)

* Add back in support for children

* Be more careful

* Enables most slot tests (withastro#1494)

* Enables most slot tests

* Use spreadAttributes

* Add hydration to Solid renderer (withastro#1479) (withastro#1495)

* feat: add hydration to Solid renderer

* fix: intersection observer, move script to the end

Co-authored-by: Ryan Carniato <[email protected]>

* [next] support Astro.slots API (withastro#1516)

* [next] Support for custom elements (withastro#1528)

* [next] Support for custom elements

* Fix eslint errors

* eslint again

* [next] Fix Astro.fetchContent (withastro#1480)

* fix Astro.fetchContent

* fix(fetchContent): cast type

Co-authored-by: Nate Moore <[email protected]>

* Move hydration to the compiler (withastro#1547)

* Move hydration to the compiler

* Move extracting url, export to util fn

* Brings back astro-dynamic tests (withastro#1548)

* Implements top-level Astro + Astro.resolve (withastro#1556)

* Implements top-level Astro + Astro.resolve

* Fix linting

* [next] Update renderers (withastro#1509)

* chore: update vite

* fix(renderers): point renderers to resolved server/client entrypoints

* Chore: Enable more tests with new compiler changes (withastro#1558)

* [Next] `fetch` support (withastro#1563)

* fix: polyfill fetch in every ssr scenario

* test(fetch): update fetch tests

* docs: update data fetching guide to remove caveats about `fetch` and isomorphic usage

* refactor: update regex for clarity

* Restructure (withastro#1569)

* Upgrade to @astrojs/compiler 0.2.0 (withastro#1584)

* Use Vite fork (withastro#1585)

* Use Vite fork

* Fix linting

* Move Vite to vendor/ and add a license

* Fix linting

* Include the dist folder

* Update files config

* Markdown compilation (withastro#1593)

* Markdown compilation

* remove debugger

* Gets lit hydration working (withastro#1595)

* Gets Astro.fetchContent compilation to work (withastro#1596)

* Gets Astro.fetchContent compilation to work

This fixes Astro.fetchContent so that we handle esbuild transforming the
name of the nested Astro call.

* Remove debugging

* Update the tests

* Remove another debugger

* Update Vite to latest (withastro#1597)

* Add Prism syntax highlighting (withastro#1598)

* Scoped styles with markdown (withastro#1599)

* Bugfix: fix getStaticPaths() cache miss (withastro#1602)

* Fix build order (withastro#1609)

* Bugfix: restore build to get all paths earlier, when build. Same as main.

* Also re-add timings

* [next] blog example fully working (withastro#1610)

* Add environment variables docs (Closes withastro#873) (withastro#1587)

* Added environment variables docs (Closes withastro#873)

* Fixed prefix

* Remove numbered comments (withastro#1611)

* Chore: remove numbered comments

* Clean up block comments

* comment style fixes (withastro#1614)

* [next] Upgrade compiler (withastro#1619)

* [next] Upgrade compiler

* Upgrade to latest compiler

* Fix the path to global css

* Removed debugger

* feat: add fragment support to vite-plugin-astro (withastro#1600)

* [next] fix `.tsx` handling (withastro#1620)

* fix: support tsx in JSX plugin

* fix: preserve JSX via esbuild, only use Babel for JSX compilation

* fix: handle upcoming Vite API for `ssr` flag

* [next] Add CSS preprocessing  (withastro#1589)

* Add concept for style support in Astro

* Update style preprocessor to use new compiler

* fix: massage preprocessStyle type

* fix: @astrojs/compiler types

Co-authored-by: Nate Moore <[email protected]>

* fix issues in blog-multiple-authors (withastro#1621)

* Move Sass to deps (withastro#1622)

* Update renderer API for Vite (withastro#1623)

* Update renderer API for Vite

* Fix lit-element tests

* Clean up comments

* Throw friendly error if renderer provides viteConfig in a bad format

* Fix changesets (withastro#1628)

* Remove cheerio scanning from build stats (withastro#1629)

* Minor change to jsxTransformOptions, update Renderer API docs (withastro#1630)

* [next] docs example fully working (withastro#1627)

* [next] docs example fully working

* Upgrade compiler to unlock docs

* Add `class:list` directive (withastro#1612)

* Add support for class:list directive

The `class:list` directive serializes an expression of css class names. For React components, `className:list` is also supported.

* Remove `className` support and React tests

* Add tests for the absence of omitted classes

* fix: `define:vars` scoping for styles (withastro#1632)

* feat: fix Debug component (withastro#1633)

* [next] Fix `<Markdown>` component (withastro#1631)

* fix: cleanup issues with <Markdown> component

* fix: fix `content` usage with Markdown

* [next] Fix `<Code>` component (withastro#1635)

* fix: enable Code component

* test: update expect to chai format

* Fixes solid (withastro#1634)

* Fixes solid

* Rename the test

* Rebase with next

* Skip solid test for now

* Add support for markdown plugins (withastro#1650)

* Fix broken next release (withastro#1652)

* Prevent passing  to Svelte components

* Prevent passing class to Vue components

* Add CSS injection, fix portfolio example (withastro#1648)

* Fix portfolio example

* Add .pcss extension

* Update load ssr opts

* Update packages/astro/src/runtime/server/index.ts

Co-authored-by: Jonathan Neal <[email protected]>

Co-authored-by: Nate Moore <[email protected]>
Co-authored-by: Jonathan Neal <[email protected]>

* Fixes external HMR (withastro#1654)

* Upgrade compiler version (withastro#1655)

Fixes docs and blog examples

* Resolve renderers relative to the projectRoot (withastro#1659)

* Template fixes (withastro#1656)

* fix: dedupe hashes for identical islands (withastro#1660)

* fix: scope `define:vars` to `:root` for `<style global>` (withastro#1663)

* chore: update compiler to latest (withastro#1664)

* [next] fix island hydration inside of `<Markdown>` (withastro#1665)

* fix: create rehype plugin to smooth over island hydration bugs

* refactor: remove debug code

* chore: explain need for `rehypeIslands`

* Bugfix: renderer-lit missing files on npm (withastro#1669)

* Force Vite to rebuild dependencies (withastro#1670)

* [next] Add `preact/compat` renderer (withastro#1668)

* feat: add preact/compat entry for `@astrojs/renderer-preact`

* Update index.js

* Bugfix: plugin-astro-fetch tries to append node-fetch to node-fetch (withastro#1671)

* Fix Vite race condition (withastro#1674)

* Fix with-nanostore deps (withastro#1675)

Adds missing Solid renderer

* [next] Fix `resolveDependency` on Windows (withastro#1666)

* fix: Windows issue with resolveDependency util

* chore: add comment

* Update CONTRIBUTING.md (withastro#1677)

* Prevent scanning a user's deps (withastro#1678)

* Prevent scanning a user's deps

* Remove unused things

* remove unused util

* Adding a changeset for the remark plugin

* Config changes needed for stater template (withastro#1680)

This does 2 things:

1. Adds prismjs as a dep.
2. Adds shiki as an external.

* Next bugs (withastro#1681)

* fix(withastro#1679): hoisted <script> rendering

* fix(withastro#1679): do not print global for styles, but do for scripts

* fix: update ObjectSet implementation

* fix: dedupe elements in sets

* [next] update compiler (withastro#1683)

* chore: update compiler

* chore: update compiler (again)

* Fix Astro HMR bottleneck (withastro#1684)

* Bugfix: JSX renderers can be declared in any order (withastro#1686)

* chore: update compiler (withastro#1690)

* Exclude lit-server from being optimized (withastro#1691)

This should get the lit example working from `npm`.

* fix: exclude all renderer server entrypoints (withastro#1692)

* chore: update compiler (withastro#1705)

* fix: do not crash when Markdown has no content (withastro#1702)

* feat: improve support for third-party React packages (withastro#1701)

* Remove prism warning when no language is provided (withastro#1703)

* Remove prism warning when no language is provided

* Add the plaintext language instead

* retry deploy

* chore: enter prerelease mode under `next` (withastro#1707)

* Updates to the changesets (withastro#1708)

* Updates to the changesets

* Adds a changeset for astro-prism

Co-authored-by: Fred K. Schott <[email protected]>
Co-authored-by: Nate Moore <[email protected]>
Co-authored-by: Nate Moore <[email protected]>
Co-authored-by: Pranav Karawale <[email protected]>
Co-authored-by: Matthew Phillips <[email protected]>
Co-authored-by: Matthew Phillips <[email protected]>
Co-authored-by: Ryan Carniato <[email protected]>
Co-authored-by: AsyncBanana <[email protected]>
Co-authored-by: Jonathan Neal <[email protected]>
SiriousHunter pushed a commit to SiriousHunter/astro that referenced this issue Feb 3, 2023
* make astro-root uids unique

* Move Astro to Vite

* Update tests

* More test improvements

* fred fixes

* Update compiler, improve tests

* Fix runtime, improve code frame

* Add Markdown support

* Tycho fixes

* Fred fixes part 2

* Throw Error for WIP Features

* Improve testing suite

* Allow users to pass config to Vite

* Fix npm install (withastro#1407)

* Automate publish on merge (withastro#1408)

* Add NPM_TOKEN to publish script (withastro#1409)

* Create .npmrc

* Clean up astro deps (withastro#1411)

* Use new renderers (withastro#1412)

* feat: update compiler (withastro#1421)

* Try mocha/chai test runners (withastro#1418)

* Try mocha/chai test runners

* Disable failing smoke test for now

Will revert when next can build docs

* Enable mocha in parallel mode

* Remove warning

* Update docs

* Fix Windows bug

* Fix internal imports

* Fix styles

* Fix CI release on merge to next (withastro#1427)

* Fix logger locale parsing (withastro#1439)

* fix(logger): locale parsing
* Fixed issue of compiler crash when "c" locale was encountered
* Return default locale if parsed locale is less than 2 chars long

* chore: add changeset

* Apply changes from withastro#1387

* Add back in support for children (withastro#1486)

* Add back in support for children

* Be more careful

* Enables most slot tests (withastro#1494)

* Enables most slot tests

* Use spreadAttributes

* Add hydration to Solid renderer (withastro#1479) (withastro#1495)

* feat: add hydration to Solid renderer

* fix: intersection observer, move script to the end

Co-authored-by: Ryan Carniato <[email protected]>

* [next] support Astro.slots API (withastro#1516)

* [next] Support for custom elements (withastro#1528)

* [next] Support for custom elements

* Fix eslint errors

* eslint again

* [next] Fix Astro.fetchContent (withastro#1480)

* fix Astro.fetchContent

* fix(fetchContent): cast type

Co-authored-by: Nate Moore <[email protected]>

* Move hydration to the compiler (withastro#1547)

* Move hydration to the compiler

* Move extracting url, export to util fn

* Brings back astro-dynamic tests (withastro#1548)

* Implements top-level Astro + Astro.resolve (withastro#1556)

* Implements top-level Astro + Astro.resolve

* Fix linting

* [next] Update renderers (withastro#1509)

* chore: update vite

* fix(renderers): point renderers to resolved server/client entrypoints

* Chore: Enable more tests with new compiler changes (withastro#1558)

* [Next] `fetch` support (withastro#1563)

* fix: polyfill fetch in every ssr scenario

* test(fetch): update fetch tests

* docs: update data fetching guide to remove caveats about `fetch` and isomorphic usage

* refactor: update regex for clarity

* Restructure (withastro#1569)

* Upgrade to @astrojs/compiler 0.2.0 (withastro#1584)

* Use Vite fork (withastro#1585)

* Use Vite fork

* Fix linting

* Move Vite to vendor/ and add a license

* Fix linting

* Include the dist folder

* Update files config

* Markdown compilation (withastro#1593)

* Markdown compilation

* remove debugger

* Gets lit hydration working (withastro#1595)

* Gets Astro.fetchContent compilation to work (withastro#1596)

* Gets Astro.fetchContent compilation to work

This fixes Astro.fetchContent so that we handle esbuild transforming the
name of the nested Astro call.

* Remove debugging

* Update the tests

* Remove another debugger

* Update Vite to latest (withastro#1597)

* Add Prism syntax highlighting (withastro#1598)

* Scoped styles with markdown (withastro#1599)

* Bugfix: fix getStaticPaths() cache miss (withastro#1602)

* Fix build order (withastro#1609)

* Bugfix: restore build to get all paths earlier, when build. Same as main.

* Also re-add timings

* [next] blog example fully working (withastro#1610)

* Add environment variables docs (Closes withastro#873) (withastro#1587)

* Added environment variables docs (Closes withastro#873)

* Fixed prefix

* Remove numbered comments (withastro#1611)

* Chore: remove numbered comments

* Clean up block comments

* comment style fixes (withastro#1614)

* [next] Upgrade compiler (withastro#1619)

* [next] Upgrade compiler

* Upgrade to latest compiler

* Fix the path to global css

* Removed debugger

* feat: add fragment support to vite-plugin-astro (withastro#1600)

* [next] fix `.tsx` handling (withastro#1620)

* fix: support tsx in JSX plugin

* fix: preserve JSX via esbuild, only use Babel for JSX compilation

* fix: handle upcoming Vite API for `ssr` flag

* [next] Add CSS preprocessing  (withastro#1589)

* Add concept for style support in Astro

* Update style preprocessor to use new compiler

* fix: massage preprocessStyle type

* fix: @astrojs/compiler types

Co-authored-by: Nate Moore <[email protected]>

* fix issues in blog-multiple-authors (withastro#1621)

* Move Sass to deps (withastro#1622)

* Update renderer API for Vite (withastro#1623)

* Update renderer API for Vite

* Fix lit-element tests

* Clean up comments

* Throw friendly error if renderer provides viteConfig in a bad format

* Fix changesets (withastro#1628)

* Remove cheerio scanning from build stats (withastro#1629)

* Minor change to jsxTransformOptions, update Renderer API docs (withastro#1630)

* [next] docs example fully working (withastro#1627)

* [next] docs example fully working

* Upgrade compiler to unlock docs

* Add `class:list` directive (withastro#1612)

* Add support for class:list directive

The `class:list` directive serializes an expression of css class names. For React components, `className:list` is also supported.

* Remove `className` support and React tests

* Add tests for the absence of omitted classes

* fix: `define:vars` scoping for styles (withastro#1632)

* feat: fix Debug component (withastro#1633)

* [next] Fix `<Markdown>` component (withastro#1631)

* fix: cleanup issues with <Markdown> component

* fix: fix `content` usage with Markdown

* [next] Fix `<Code>` component (withastro#1635)

* fix: enable Code component

* test: update expect to chai format

* Fixes solid (withastro#1634)

* Fixes solid

* Rename the test

* Rebase with next

* Skip solid test for now

* Add support for markdown plugins (withastro#1650)

* Fix broken next release (withastro#1652)

* Prevent passing  to Svelte components

* Prevent passing class to Vue components

* Add CSS injection, fix portfolio example (withastro#1648)

* Fix portfolio example

* Add .pcss extension

* Update load ssr opts

* Update packages/astro/src/runtime/server/index.ts

Co-authored-by: Jonathan Neal <[email protected]>

Co-authored-by: Nate Moore <[email protected]>
Co-authored-by: Jonathan Neal <[email protected]>

* Fixes external HMR (withastro#1654)

* Upgrade compiler version (withastro#1655)

Fixes docs and blog examples

* Resolve renderers relative to the projectRoot (withastro#1659)

* Template fixes (withastro#1656)

* fix: dedupe hashes for identical islands (withastro#1660)

* fix: scope `define:vars` to `:root` for `<style global>` (withastro#1663)

* chore: update compiler to latest (withastro#1664)

* [next] fix island hydration inside of `<Markdown>` (withastro#1665)

* fix: create rehype plugin to smooth over island hydration bugs

* refactor: remove debug code

* chore: explain need for `rehypeIslands`

* Bugfix: renderer-lit missing files on npm (withastro#1669)

* Force Vite to rebuild dependencies (withastro#1670)

* [next] Add `preact/compat` renderer (withastro#1668)

* feat: add preact/compat entry for `@astrojs/renderer-preact`

* Update index.js

* Bugfix: plugin-astro-fetch tries to append node-fetch to node-fetch (withastro#1671)

* Fix Vite race condition (withastro#1674)

* Fix with-nanostore deps (withastro#1675)

Adds missing Solid renderer

* [next] Fix `resolveDependency` on Windows (withastro#1666)

* fix: Windows issue with resolveDependency util

* chore: add comment

* Update CONTRIBUTING.md (withastro#1677)

* Prevent scanning a user's deps (withastro#1678)

* Prevent scanning a user's deps

* Remove unused things

* remove unused util

* Adding a changeset for the remark plugin

* Config changes needed for stater template (withastro#1680)

This does 2 things:

1. Adds prismjs as a dep.
2. Adds shiki as an external.

* Next bugs (withastro#1681)

* fix(withastro#1679): hoisted <script> rendering

* fix(withastro#1679): do not print global for styles, but do for scripts

* fix: update ObjectSet implementation

* fix: dedupe elements in sets

* [next] update compiler (withastro#1683)

* chore: update compiler

* chore: update compiler (again)

* Fix Astro HMR bottleneck (withastro#1684)

* Bugfix: JSX renderers can be declared in any order (withastro#1686)

* chore: update compiler (withastro#1690)

* Exclude lit-server from being optimized (withastro#1691)

This should get the lit example working from `npm`.

* fix: exclude all renderer server entrypoints (withastro#1692)

* chore: update compiler (withastro#1705)

* fix: do not crash when Markdown has no content (withastro#1702)

* feat: improve support for third-party React packages (withastro#1701)

* Remove prism warning when no language is provided (withastro#1703)

* Remove prism warning when no language is provided

* Add the plaintext language instead

* retry deploy

* chore: enter prerelease mode under `next` (withastro#1707)

* Updates to the changesets (withastro#1708)

* Updates to the changesets

* Adds a changeset for astro-prism

Co-authored-by: Fred K. Schott <[email protected]>
Co-authored-by: Nate Moore <[email protected]>
Co-authored-by: Nate Moore <[email protected]>
Co-authored-by: Pranav Karawale <[email protected]>
Co-authored-by: Matthew Phillips <[email protected]>
Co-authored-by: Matthew Phillips <[email protected]>
Co-authored-by: Ryan Carniato <[email protected]>
Co-authored-by: AsyncBanana <[email protected]>
Co-authored-by: Jonathan Neal <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

3 participants