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(comments): add docs for markdown comments #815

Merged
merged 4 commits into from
Apr 17, 2020
Merged

feat(comments): add docs for markdown comments #815

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0d50885
feat(comments): add docs for markdown comments
tay1orjones Apr 16, 2020
cff83d5
fix(markdown): add comments anchorlink
tay1orjones Apr 16, 2020
6f5c5d9
Merge branch 'master' into comments
tay1orjones Apr 17, 2020
05e73dc
Merge branch 'master' into comments
vpicone Apr 17, 2020
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
19 changes: 17 additions & 2 deletions packages/example/src/pages/components/markdown.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ For most pages, we recommend starting with a `PageDescription` followed by `Anch
<AnchorLink>Code blocks</AnchorLink>
<AnchorLink>Tables</AnchorLink>
<AnchorLink>Blockquotes and citations</AnchorLink>
<AnchorLink>Comments</AnchorLink>
</AnchorLinks>

## Text decoration
Expand Down Expand Up @@ -128,7 +129,7 @@ Strikethrough uses two tildes. ~~Scratch this.~~

[I’m a markdown link](https://www.carbondesignsystem.com)

[I’m a markdown link with title](https://www.carbondesignsystem.com 'Carbon’s Homepage')
[I’m a markdown link with title](https://www.carbondesignsystem.com "Carbon’s Homepage")

URLs and URLs in angle brackets will automatically get turned into links.
http://www.example.com or <http://www.example.com> and sometimes
Expand All @@ -139,7 +140,7 @@ example.com (but not on Github, for example).
```markdown src=https://github.com/carbon-design-system/gatsby-theme-carbon/tree/master/packages/gatsby-theme-carbon/src/components/markdown
[I’m a markdown link](https://www.carbondesignsystem.com)

[I’m a markdown link with title](https://www.carbondesignsystem.com 'Google’s Homepage')
[I’m a markdown link with title](https://www.carbondesignsystem.com "Google’s Homepage")

[I’m a local link](/components/demo)

Expand Down Expand Up @@ -245,3 +246,17 @@ raw Markdown line up prettily. You can also use inline Markdown.
>
> <cite>– Paul Rand</cite>
```

## Comments

Comments can be added that will not display on the page, but will be visible in the markdown source.

<!-- Comments like this are visible in code, but are not visible on the page -->

### Code

```markdown src=https://github.com/carbon-design-system/gatsby-theme-carbon/tree/master/packages/gatsby-theme-carbon/src/components/markdown
Comments can be added that will not display on the page, but will be visible in the markdown source.

<!-- Comments like this are visible in code, but are not visible on the page -->
```