Skip to content

Commit

Permalink
examples page
Browse files Browse the repository at this point in the history
  • Loading branch information
justinwhall committed Dec 3, 2018
1 parent 01111d2 commit c5c0ac8
Show file tree
Hide file tree
Showing 7 changed files with 152 additions and 22 deletions.
95 changes: 95 additions & 0 deletions content/docs/examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
title: Markdown Examples
slug: markdown-examples
navigation:
show: true
---

## Academy Callout

```html
<academy-link img="/img/search-darth-vader.gif" courselink="https://sendgrid.com/">

### I'm a course call out title

Montes sociis turpis egestas fermentum tempus lectus cubilia vulputate justo, placerat suscipit mollis nostra mauris at sed adipiscing, enim pharetra laoreet ridiculus litora nunc.

</academy-link>
```

<academy-link img="/img/search-darth-vader.gif" courselink="https://sendgrid.com/">

### I'm a course call out title

Montes sociis turpis egestas fermentum tempus lectus cubilia vulputate justo, placerat suscipit mollis nostra mauris at sed adipiscing, enim pharetra laoreet ridiculus litora nunc.

</academy-link>

## Callouts

### Callout Info

```html
<call-out>

Montes sociis turpis egestas fermentum tempus lectus cubilia vulputate justo, placerat suscipit mollis nostra mauris at sed adipiscing, enim pharetra laoreet ridiculus litora nunc.

</callout>
```

<call-out>

Montes sociis turpis egestas fermentum tempus lectus cubilia vulputate justo, placerat suscipit mollis nostra mauris at sed adipiscing, enim pharetra laoreet ridiculus litora nunc.

</call-out>

### Callout Warning

```html
<call-out type="warning">

Montes sociis turpis egestas fermentum tempus lectus cubilia vulputate justo, placerat suscipit mollis nostra mauris at sed adipiscing, enim pharetra laoreet ridiculus litora nunc.

</callout>
```
<call-out type="warning">

Montes sociis turpis egestas fermentum tempus lectus cubilia vulputate justo, placerat suscipit mollis nostra mauris at sed adipiscing, enim pharetra laoreet ridiculus litora nunc.

</call-out>

## Code Group

````html
<code-group langs="Html, JavaScript, Go">

```html
<div class="yay-html">Yay HTML</div>
```

```javascript
consol.log('Yay, JavaScript!')
```

```go
print('Yay, Go!');
```
</code-group>
````


<code-group langs="Html, JavaScript, Go">

```html
<div class="yay-html">Yay HTML</div>
```

```javascript
consol.log('Yay, JavaScript!')
```

```go
print('Yay, Go!');
```
</code-group>

2 changes: 2 additions & 0 deletions data/SiteConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,6 @@ const config = {
userTwitter: 'sendgrid',
};

config.envPrefix = process.env.NODE_ENV === 'development' ? '' : config.pathPrefix;

module.exports = config;
1 change: 1 addition & 0 deletions plugins/sendgrid-remark-headers/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ module.exports = ({ markdownAST }) => {
patch(data, 'hProperties', {});
patch(data.htmlAttributes, 'id', id);
patch(data.hProperties, 'id', id);
patch(data.hProperties, 'class', 'sg-remarked-linked-header');

node.children.unshift({
type: 'link',
Expand Down
13 changes: 7 additions & 6 deletions src/componentsMarkdown/AcademyLink.jsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import React from 'react';
import config from '../../data/SiteConfig';

export default function AcademyLink(props) {
// check for empty AcademyLink
Expand All @@ -7,12 +8,12 @@ export default function AcademyLink(props) {
}

return (
<div>
AcademyLink
<div className="academy-callout">
<div className="academy-callout__copy">
{props.children.map(el => el)}
<a href={props.courselink}>GO TO COURSE →</a>
</div>
<div className="academy-callout__img" style={{ backgroundImage: `url(${config.envPrefix + props.img})` }} />
</div>
);
}

AcademyLink.defaultProps = {
type: 'info',
};
22 changes: 11 additions & 11 deletions src/componentsMarkdown/Callout.jsx
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
import React from 'react';

export default function Callout(props) {
// check for empty callout
if (!props.children) {
return null;
}
// check for empty callout
if (!props.children) {
return null;
}

const classes = `callout callout--${props.type}`;
return (
<div className={classes}>
{props.children.map(el => el)}
</div>
);
const classes = `callout callout--${props.type}`;

return (
<div className={classes}>
{props.children.map(el => el)}
</div>
);
}

Callout.defaultProps = {
Expand Down
2 changes: 2 additions & 0 deletions src/templates/doc.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import _ from 'lodash';
import config from '../../data/SiteConfig';
import SEO from '../components/SEO';
import AsideMenu from '../components/AsideMenu';
import AcademyLink from '../componentsMarkdown/AcademyLink';
import Callout from '../componentsMarkdown/Callout';
import Gist from '../componentsMarkdown/Gist';
import CodeGroup from '../componentsMarkdown/CodeGroup';
Expand All @@ -15,6 +16,7 @@ const renderAst = new RehypeReact({
createElement: React.createElement,
components: {
gist: Gist,
'academy-link': AcademyLink,
'call-out': Callout,
'code-group': CodeGroup,
},
Expand Down
39 changes: 34 additions & 5 deletions src/templates/doc.scss
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ $aside-width: 300px;
}
}

.sg-remarked-linked-header {
margin-left: -25px;
display: flex;
}

.doc-main {
flex: 1;
overflow: hidden;
Expand All @@ -27,10 +32,6 @@ $aside-width: 300px;
padding: 0 0 $scaleup-6;
}

h2, h3 {
margin-left: -25px;
display: flex;
}

ol, ul {
margin: $scaleup-1 0 $scaleup-1 $scaleup-1;
Expand Down Expand Up @@ -184,7 +185,8 @@ aside a.active {
flex: 1;
}

.gatsby-resp-iframe-wrapper, .table-wrap {
.gatsby-resp-iframe-wrapper,
.table-wrap {
margin: $scaleup-2 0;
}

Expand Down Expand Up @@ -212,3 +214,30 @@ aside a.active {
.edit-this-page {
font-size: $scaledown-1;
}

.academy-callout {
@include dropdown-shadow();

display: grid;
grid-template-columns: auto auto;
margin: $scaleup-4 0;

.sg-remarked-linked-header {
margin-left: 0;

> a {
display: none;
}
}
}

.academy-callout__copy {
padding: $scale-0;
}

.academy-callout__img {
background-position: center center;
background-size: cover;
margin-left: $scaleup-1;
width: 175px;
}

0 comments on commit c5c0ac8

Please sign in to comment.