[docs] Document base #5693
[docs] Document base #5693
Conversation
|
github-actions
bot
added
the
pkg: astro
packages/astro/src/@types/astro.ts
Outdated
| * <a href="/docs/about/>About</a> | ||
| * <img src="/docs/image.png"> |
There was a problem hiding this comment.
Maybe show how we'd write URLs that adapt to changing base URLs?
| * <a href="/docs/about/>About</a> | |
| * <img src="/docs/image.png"> | |
| * <a href="{import.meta.env.BASE_URL}/about/">About</a> | |
| * <img src="{import.meta.env.BASE_URL}/image.png"> |
There was a problem hiding this comment.
Should we show this instead of using the base from the example? Or in addition to?
There was a problem hiding this comment.
I'd thought the literal base was clear enough, but it might not be. You could do one of each?
There was a problem hiding this comment.
Personally I think /docs/ is clear enough, but using `${import.meta.env.BASE_URL}/image.png` for the second example couldn't hurt.
|
Is there a way to make this work with hero? ---
hero:
actions:
- text: Getting Started
link: /guides/getting-started/ # <-- not adjusted with `base` |
Changes
Closes three open Docs issues 😅 by incorporating everyone's feedback re: documenting base.
Was previously blocked by #4988 and so placeholder language to describe actual behaviour at the time was used.
This documents the intended, and now functioning, behaviour of
base.Testing
No tests.
Docs
/cc @withastro/maintainers-docs for feedback!
/cc @matthewp for technical check!