Skip to content

Commit

Permalink
Allow customizing of blog author image URL documentation (#577)
Browse files Browse the repository at this point in the history
* Rename authorImage to authorImageURL for clarity

Update documentation

* Fix typo

* Add documentation for authorImageURL

* Add support for authorImage

We will remove support for authorImage in favor of authorImageURL, after we remove authorImage from react-native-website

* Update guides-blog.md

* Update guides-blog.md
  • Loading branch information
amyrlam authored and yangshun committed Apr 18, 2018
1 parent 71b5d46 commit 57cddb4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/guides-blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ authorFBID: 503283835
title: Introducing Docusaurus
---
Lorem Ipusm..
Lorem Ipsum...
```


Expand All @@ -41,8 +41,9 @@ Lorem Ipusm..
The only required field is `title`; however, we provide options to add author information to your blog post as well.

- `author` - The text label of the author byline.
- `authorURL` - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
- `authorFBID` - The Facebook ID that is used to extract the profile picture.
- `authorURL` - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
- `authorFBID` - The Facebook profile ID that is used to fetch the profile picture.
- `authorImageURL` - The URL to the author's image. (Note: If you use both `authorFBID` and `authorImageURL`, `authorFBID` will take precedence. Don't include `authorFBID` if you want `authorImageURL` to appear.)
- `title` - The blog post title.


Expand Down
8 changes: 8 additions & 0 deletions lib/core/BlogPost.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,14 @@ class BlogPost extends React.Component {
</a>
</div>
);
} else if (post.authorImageURL) {
return (
<div className={className}>
<a href={post.authorURL} target="_blank" rel="noreferrer noopener">
<img src={post.authorImageURL} />
</a>
</div>
);
} else {
return null;
}
Expand Down

0 comments on commit 57cddb4

Please sign in to comment.