Removes Asciinema players with custom CommandPlayer#7164
Removes Asciinema players with custom CommandPlayer#7164Jwaegebaert wants to merge 2 commits intopnp:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the Docusaurus docs to replace embedded Asciinema recordings with a custom CommandPlayer component that simulates running CLI commands and displaying responses, including support for sourcing responses from external files at build time.
Changes:
- Removed Asciinema cast assets and the
AsciinemaPlayerReact component, replacing usages in MDX pages withCommandPlayer. - Added the
CommandPlayercomponent + styling, including pause-on-scroll behavior and reduced-motion handling. - Introduced a new remark plugin to resolve
responseFromreferences at build time and updated docs config to load the plugin and CSS.
Reviewed changes
Copilot reviewed 18 out of 19 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/static/casts/home.cast | Removes legacy Asciinema cast asset. |
| docs/static/casts/usingCli.cast | Removes legacy Asciinema cast asset. |
| docs/static/casts/listCommands.cast | Removes legacy Asciinema cast asset. |
| docs/static/casts/commandHelp.cast | Removes legacy Asciinema cast asset. |
| docs/static/casts/logout.cast | Removes legacy Asciinema cast asset. |
| docs/static/casts/install.cast | Removes legacy Asciinema cast asset. |
| docs/src/components/AsciinemaPlayer.tsx | Removes the old Asciinema player wrapper component. |
| docs/src/components/CommandPlayer.tsx | Adds the new terminal-like command animation component. |
| docs/src/scss/CommandPlayer.module.scss | Adds global styling/theme variables for the new component. |
| docs/src/remark/commandPlayer.ts | Adds remark plugin to resolve responseFrom into response at build time. |
| docs/src/components/responses/help-spo.txt | Adds externalized response content used by CommandPlayer. |
| docs/src/components/responses/spo-cdn-get-help.txt | Adds externalized response content used by CommandPlayer. |
| docs/docusaurus.config.ts | Registers the remark plugin and includes the new CSS. |
| docs/docs/index.mdx | Replaces Asciinema embed with CommandPlayer sequence. |
| docs/docs/user-guide/using-cli.mdx | Replaces Asciinema embeds with CommandPlayer + responseFrom. |
| docs/docs/user-guide/connecting-microsoft-365.mdx | Replaces Asciinema embed with CommandPlayer. |
| docs/docs/user-guide/installing-cli.mdx | Removes Asciinema embed from install page. |
| docs/package.json | Removes asciinema-player and updates devDependencies. |
| docs/package-lock.json | Updates lockfile to reflect dependency changes. |
Files not reviewed (1)
- docs/package-lock.json: Language not supported
You can also share your feedback on Copilot code review. Take the survey.
There was a problem hiding this comment.
Pull request overview
This PR replaces the docs’ Asciinema-based terminal recordings with a custom CommandPlayer component and a remark plugin that can source response output from existing command docs (## Response) or plain text files, addressing the need to remove Asciinema players from the documentation.
Changes:
- Added
CommandPlayerReact component + styling to render a looping “typed terminal” experience. - Added a remark plugin to resolve
responseFromat build time (from MDX## ResponseJSON blocks or.txtfiles). - Removed Asciinema players/cast assets and updated relevant docs pages to use
CommandPlayer.
Reviewed changes
Copilot reviewed 18 out of 19 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/static/casts/usingCli.cast | Removed obsolete Asciinema cast recording. |
| docs/static/casts/logout.cast | Removed obsolete Asciinema cast recording. |
| docs/static/casts/listCommands.cast | Removed obsolete Asciinema cast recording. |
| docs/static/casts/install.cast | Removed obsolete Asciinema cast recording. |
| docs/static/casts/home.cast | Removed obsolete Asciinema cast recording. |
| docs/static/casts/commandHelp.cast | Removed obsolete Asciinema cast recording. |
| docs/src/scss/CommandPlayer.module.scss | Added global styles and theme variables for the new terminal UI. |
| docs/src/remark/commandPlayer.ts | Added remark plugin to resolve responseFrom and inject response at build time. |
| docs/src/components/responses/spo-cdn-get-help.txt | Added external response content used by CommandPlayer. |
| docs/src/components/responses/help-spo.txt | Added external response content used by CommandPlayer. |
| docs/src/components/CommandPlayer.tsx | Added the new terminal-like command playback component. |
| docs/src/components/AsciinemaPlayer.tsx | Removed Asciinema player component. |
| docs/package.json | Dropped asciinema-player, added acorn for expression parsing in remark plugin. |
| docs/package-lock.json | Updated lockfile to reflect dependency changes (including removal of Asciinema transitive deps). |
| docs/docusaurus.config.ts | Registered the new remark plugin and included CommandPlayer styles in customCss. |
| docs/docs/user-guide/using-cli.mdx | Replaced Asciinema embeds with CommandPlayer usage. |
| docs/docs/user-guide/installing-cli.mdx | Removed Asciinema embed from install guide section. |
| docs/docs/user-guide/connecting-microsoft-365.mdx | Replaced Asciinema embed with CommandPlayer usage. |
| docs/docs/index.mdx | Replaced Asciinema embed with multi-step CommandPlayer demo using responseFrom. |
Files not reviewed (1)
- docs/package-lock.json: Language not supported
You can also share your feedback on Copilot code review. Take the survey.
There was a problem hiding this comment.
Pull request overview
This PR removes Asciinema-based terminal recordings from the Docusaurus docs and replaces them with a custom CommandPlayer component that simulates typed commands + responses, optionally sourcing responses from external files at build time via a new remark plugin.
Changes:
- Replaced
AsciinemaPlayerusage in key docs pages with the newCommandPlayer. - Added a
commandPlayerremark plugin to resolveresponseFromreferences (from command MDX## ResponseJSON blocks or raw.txtfiles). - Removed obsolete
.castassets and theasciinema-playerdependency; added styling and new response fixture files.
Reviewed changes
Copilot reviewed 18 out of 19 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/static/casts/usingCli.cast | Removed unused Asciinema cast recording |
| docs/static/casts/logout.cast | Removed unused Asciinema cast recording |
| docs/static/casts/listCommands.cast | Removed unused Asciinema cast recording |
| docs/static/casts/install.cast | Removed unused Asciinema cast recording |
| docs/static/casts/home.cast | Removed unused Asciinema cast recording |
| docs/static/casts/commandHelp.cast | Removed unused Asciinema cast recording |
| docs/src/scss/CommandPlayer.module.scss | Added global styling + theme variables for CommandPlayer |
| docs/src/remark/commandPlayer.ts | Added remark plugin to inline responses from MDX/TXT into CommandPlayer props |
| docs/src/components/responses/spo-cdn-get-help.txt | Added help output fixture for CommandPlayer |
| docs/src/components/responses/help-spo.txt | Added help output fixture for CommandPlayer |
| docs/src/components/CommandPlayer.tsx | Added the new animated terminal-like CommandPlayer React component |
| docs/src/components/AsciinemaPlayer.tsx | Removed Asciinema player component |
| docs/package.json | Dropped asciinema-player, added acorn for expression re-parsing |
| docs/package-lock.json | Lockfile updates reflecting dependency changes |
| docs/docusaurus.config.ts | Registered remark plugin and included CommandPlayer CSS in customCss |
| docs/docs/user-guide/using-cli.mdx | Replaced Asciinema embeds with CommandPlayer examples (incl. responseFrom) |
| docs/docs/user-guide/installing-cli.mdx | Removed Asciinema embed from install guide |
| docs/docs/user-guide/connecting-microsoft-365.mdx | Replaced Asciinema embed with CommandPlayer example |
| docs/docs/index.mdx | Replaced homepage Asciinema embed with multi-step CommandPlayer sequence |
Files not reviewed (1)
- docs/package-lock.json: Language not supported
You can also share your feedback on Copilot code review. Take the survey.
Replaced the old AsciinemaPlayer with a custom
CommandPlayercomponent, basically a fake terminal that types out commands and shows responses, then loops.What it does
clear, and starts overresponseFrompropResponses can be pulled from external files at build time instead of being inlined in the MDX. A remark plugin handles this, it reads JSON from a command page's
## Responsesection (.mdx) or just grabs the raw content of a.txtfile.Works on standalone
<CommandPlayer />and insidecommands={[...]}arrays.Closes #7130