3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-02 16:29:47 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: improve alt messages (#8047)

Browse source
This commit is contained in:
Joshua Chen 2022-09-04 01:33:25 -04:00 • committed by GitHub
parent 1f1f898d73
commit 36db64ed1d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 76 additions and 72 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/docs/api/docusaurus.config.js.md
View file

@ -563,7 +563,7 @@ module.exports = {
};
```
![baseUrlIssueBanner](/img/baseUrlIssueBanner.png)
![A sample base URL issue banner. The style is very raw since the stylesheets failed to load. The text says "Your Docusaurus site did not load properly... Current configured baseUrl = / (default value); We suggest trying baseUrl = /build/](/img/baseUrlIssueBanner.png)
:::caution

2
website/docs/api/misc/logger/logger.md
View file

@ -66,4 +66,4 @@ An embedded expression is optionally preceded by a flag in the form `[a-z]+=` (a
If the expression is an array, it's formatted by `` `\n- ${array.join('\n- ')}\n` `` (note it automatically gets a leading line end). Each member is formatted by itself and the bullet is not formatted. So you would see the above message printed as:
![demo](./demo.png)
![Some text output in the terminal, containing array, code, name, and number formatting](./demo.png)

4
website/docs/api/plugins/plugin-pwa.md
View file

@ -66,7 +66,7 @@ For a more exhaustive list of what it takes for your site to be a PWA, refer to
If your browser supports it, you should be able to install a Docusaurus site as an app.
![pwa_install.gif](/img/pwa_install.gif)
![A screen recording of the installation process. A button appears in the address bar of the browser, which displays a dialog asking "install this application?" when clicked. After clicking the "Install" button, a new application is opened in the operating system, opening to the Docusaurus homepage.](/img/pwa_install.gif)
:::note
@ -298,6 +298,6 @@ The `@theme/PwaReloadPopup` component is rendered when a new service worker is w
The default theme includes an implementation for the reload popup and uses [Infima Alerts](https://infima.dev/docs/components/alert).
![pwa_reload.gif](/img/pwa_reload.gif)
![A screen recording of the reload process. An alert box shows in the bottom right of the window, saying "New content available". After clicking the "Refresh" button, the page's main heading changes from "Introduction" to "PWA :))".](/img/pwa_reload.gif)
Your component can render `null`, but this is not recommended: users won't have a way to get up-to-date content.

2
website/docs/introduction.md
View file

@ -15,7 +15,7 @@ slug: /
🧐 Docusaurus is a **static-site generator**. It builds a **single-page application** with fast client-side navigation, leveraging the full power of **React** to make your site interactive. It provides out-of-the-box **documentation features** but can be used to create **any kind of site** (personal website, product, blog, marketing landing pages, etc).
![Docusaurus Slash Introduction](/img/slash-introducing.svg)
![](/img/slash-introducing.svg)
## Fast Track ⏱️ {#fast-track}