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.

Sign up for GitHub

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

feat(nx-dev): allow custom media images #20561

Merged
merged 5 commits into from
Dec 7, 2023
Merged

feat(nx-dev): allow custom media images #20561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a038d4d
feat(nx-dev): allow custom media images
isaacplmann Dec 4, 2023
33f06d4
feat(nx-dev): don't show content text
isaacplmann Dec 4, 2023
3f06576
feat(nx-dev): allow custom media images
isaacplmann Dec 4, 2023
cc7e3e2
feat(nx-dev): allow custom media images
isaacplmann Dec 4, 2023
d0912b8
feat(nx-dev): allow custom media images
isaacplmann Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ description: This is a custom description
---
```

### Social Media Images

You can specify a custom social media image for a page by specifying `mediaImage` in the `map.json` entry for that page. `mediaImage` is a path relative to `/docs`.

Note that you won't see the social media image in the preview generated for your PR, because it loads from the live `nx.dev` site. You can make sure the image is correct by looking at `[preview-url]/images/open-graph/[page-url].[image-extension]`.

### Custom markdown syntax

The documentation website [nx.dev](https://nx.dev) is using custom Markdown syntax to enable the authors to add functionality to its content.
Expand Down
Loading