diff --git a/README.md b/README.md index 1c9fe4303b..95ecf7a842 100644 --- a/README.md +++ b/README.md @@ -395,19 +395,19 @@ Using markdown links to link to pages e.g. : _Relative link_ -``` +```markdown [Link to mypage](../mypage.md) ``` _Absolute link_ -``` +```markdown [Link to mypage](/src/pages/mypage.md) ``` Add the suffix `#` to a link to jump to a section of the page for example if your page has a heading named `Join the future`, you can link to it: -``` +```markdown [Link to mypage](../mypage.md#join-the-future) ``` @@ -415,13 +415,13 @@ You can also use absolute links or relative links to link between markdown pages _Relative link_ -``` +```markdown [Link to API](../api/) ``` _Absolute link_ -``` +```markdown [Link to API](/api/) ``` @@ -431,7 +431,7 @@ _Absolute link_ External links will automatically open in a new tab or window. -``` +```markdown [Link to example.com](https://example.com) ``` @@ -458,13 +458,13 @@ root where `image.png` is referenced in `index.md` as an image: -``` +```markdown ![alt image](./image.png) ``` and `document.pdf` is referenced in `index.md` as a link: -``` +```markdown [document](/document.pdf) ``` @@ -1302,7 +1302,7 @@ There are 3 different variants: ![hero default](docs/images/hero-default.png) -``` +```markdown ![Hero image](./illustration.png) @@ -1331,7 +1331,7 @@ Use `videoUrl` to videoURL to post the video in half width /full width ![hero halfwidth](docs/images/hero-halfwidth.png) -``` +```markdown ![Creative Cloud banner](images/cc-hero.png) @@ -1363,7 +1363,7 @@ Use `slots` to identify the markdown content: ![hero fullwidth](docs/images/hero-fullwidth.png) -``` +```markdown ![IO banner](images/io-banner.png) @@ -1397,7 +1397,7 @@ They can point to internal or external documents or pages. ![resources block](docs/images/resources-block.png) -``` +```markdown #### Resources @@ -1420,7 +1420,7 @@ Discover Blocks can be illustrated but only one illustration per row is allowed. ![single discover block](docs/images/discover-block-single.png) -``` +```markdown ### Get Started @@ -1434,7 +1434,7 @@ Get started with the Adobe Analytics APIs. ![multiple discover blocks](docs/images/discover-block-multiple.png) -``` +```markdown ### Guides @@ -1466,7 +1466,7 @@ Provides configuration guidance and best practices for the /reports endpoint. ![illustrated discover block](docs/images/discover-block-illustrated.png) -``` +```markdown ![Adobe Experience Cloud](experience_cloud.png) @@ -1680,7 +1680,7 @@ It's used to call out new features, blog posts, news etc. anything that needs th ![announcement block](docs/images/announcement-block.png) -``` +```markdown @@ -1708,7 +1708,7 @@ The Summary Block acts as an anchor at the end of the page. It's a change for Pr ![summary block](docs/images/summary-block.png) -``` +```markdown @@ -1743,7 +1743,7 @@ A Title Block is used at the beginning of sections, or to frame compositions on ![title block](docs/images/title-block.png) -``` +```markdown @@ -1771,7 +1771,7 @@ They are coupled with images or videos. **With an image, texts and links** -``` +```markdown @@ -1795,7 +1795,7 @@ And be sure to join the [Exchange Program for Creative Cloud](https://partners.a ![centered text blocks](docs/images/text-block-centered.png) -``` +```markdown @@ -1833,7 +1833,7 @@ Instantly share Creative Cloud files, designs, specs, and notifications all in r ![text block with a video](docs/images/text-block-video.png) -``` +```markdown @@ -1856,7 +1856,7 @@ world-class creative assets with the Adobe Stock API, or sign up for early infor ![text block with a local video](docs/images/textblockwithvideo.png) -``` +```markdown import video1 from '../videos/localVideo.mp4' @@ -1990,7 +1990,7 @@ Tabs block is a custom block component that allows for tabbed content that can b ![tabsBlock](docs/images/tabsBlock.png) -``` +```markdown @@ -2008,7 +2008,7 @@ Tabs block is a custom block component that allows for tabbed content that can b ``` -``` +```markdown @@ -2044,7 +2044,7 @@ Product Cards group information that allow to browse a collection of related con ![product card](docs/images/product-card.png) -``` +```markdown @@ -2121,7 +2121,7 @@ There are 2 variants: horizontal and vertical Resource Cards. Use multiple Resou ![resource card](docs/images/resource-card.png) -``` +```markdown [Adobe I/O](https://adobe.io) @@ -2173,7 +2173,7 @@ Used to display the Product information along with the images/icons and headings ![miniresource card](docs/images/mini-resource.png) -``` +```markdown ![Forge the path to customer success](./S_AniChangeBackground.png) @@ -2247,7 +2247,7 @@ Carousel is used to show the information along with images and buttons. ![Carousel](docs/images/carousel.png) -``` +```markdown ![Resource 3](images/resource3.png) @@ -2302,7 +2302,7 @@ Use `enableNavigation` to display navigation icon. By default it is in false. If Use `navigationIconColor` to change the icon color. By default it is black. -``` +```markdown import video1 from './video1.mp4' import video2 from "./video2.mp4" import video3 from "./video3.mp4" @@ -2337,7 +2337,7 @@ ImageTextBlock is used to display two images, along with text, a heading, and bu ![ImageTextBlock](docs/images/imagetext-block.png) -``` +```markdown ![Adobe Service](6_Image_Sales.jpg) @@ -2379,7 +2379,7 @@ Teaser component is used to place the text over the background image/color ![TeaserBlock](docs/images/TeaserBlock.png) -``` +```markdown import bgImg from "./Images/black_image.png" @@ -2505,7 +2505,7 @@ The PDFViewer component integrates PDF display with accompanying text, headings, ![pdfviewer](docs/images/pdf_viewer.png) -``` +```markdown import pdf from "./sample.pdf"; @@ -2551,7 +2551,7 @@ This component is designed to showcase product information using images/icons, h ![profile_card](docs/images/profile_card.png) -``` +```markdown ![Remove Background](./remove-background.svg) @@ -2640,7 +2640,7 @@ Miniproductcard component is used to display the product card with little image ![mini_product_card](docs/images/mini-product-card.png) -``` +```markdown ![Forge the path to customer success](./S_AniConvertToGIF.png) @@ -2677,7 +2677,7 @@ For example, if you want to include the content of `overview.md` into `index.md` `index.md` content: -``` +```markdown import Overview from './overview.md' # Welcome @@ -2742,7 +2742,7 @@ Both are sites using the theme and have markdown content defined under `src/page 1. repo1 has reusable markdown content written with Variant Blocks under `/src/pages/debugging/index.md`: -``` +```markdown ## How to Debug Your Plugin Bugs happen! In this tutorial, you will learn how to debug your plugin. @@ -2772,7 +2772,7 @@ _Use `repeat` to define how many elements are part of the Variant Block. Use any 3. repo2 embeds repo1 content by using the `import` statement and inserts the content in its own markdown together with a `query` filter to only display what is needed. -``` +```markdown import Debugging from 'repo1/src/pages/debugging/index.md' # Debugging @@ -2784,7 +2784,7 @@ More content will be rendered as: -``` +```markdown # Debugging ## How to Debug Your Plugin @@ -3147,4 +3147,4 @@ This can be turned off through gatsby-config.js removeLogIssue: true, }, } -``` \ No newline at end of file +```