Serverless Blog
Welcome to the serverless blog repo! Contributions, typo fixes and pull requests are welcome
Table of Contents
Click to expand
How to contribute content
1. Write your content in markdown!
New to markdown? Read this
Need Content ideas? Read this
2. Name your post file name
YYYY-MM-DD-blog-post-name.md 2016-01-27-post-title-here.md
3. In your post, include post meta information:
Include the post metadata at the top:
---
title: My awesome post title
description: "This post is about awesome stuff!"
date: 2016-07-25
thumbnail: 'http://url-to-thumbnail.jpg'
layout: Post
authors:
- FirstnameLastname
---
Below the post meta, add your markdown:
# Post Heading
This is an awesome paragraph!
## Post SubSection
[Link example](http://my-full-url-with-http-at-the-front.com)
* List item 1
* List item 2
* List item 3
```js
// code snippet example with javascript (js) syntax highlighting
console.log('JS code')
```
Questions about formatting? See a complete post example
4. Add categories
Choose appropriate categories for the blog post from the list of categories available here. Multiple categories can be assigned to a blog post.
The values that are supplied for categories for the blog post must match any of the keys in the (categories.json)[./categories.json]
If you want to add a new category, you can add another entry at categories.json and use it in the blog post.
---
layout: Post
title: David's Amazing Post
categories:
- guides-and-tutorials
- user-stories
---4. Add your author bio
If you haven't created an author bio in the /authors folder. Go ahead and do that now.
The name of the file should be the same as the name field used in the blog post meta data. Format: FirstnameLastname (note the caps and no space!)
Example authors/DavidWells.json and DavidWells in the authors field below are the same name and capitalization.
---
layout: Post
title: David's Amazing Post
authors:
- DavidWells # references data in authors/DavidWells.json file
---5. Submit a PR to the repository
Serverless team members
click here to add a post or submit a PR.
External contributors
Fork this repo and submit a PR. This video guide will walk you through the process
We will review and publish your post with our audience on serverless.com and share it all around the web!
Ping us with any questions on Twitter or post an issue and we will get back with you shortly.
6. (optional) Preview your post
Curious about what your post will look like on the live site? You can preview your post by cloning down the site repo, installing the dependencies and running
npm start.
Updating featured posts
The file featured-blogs.json contains a list of file names(excluding date and extension) of the blog posts to be featured on the website.
If the blog file name is 2016-06-28-serverless-v1-0-alpha-release-1.md, then the file name to be added in the featured-blogs.json file is: serverless-v1-0-alpha-release-1.
The order of the file names in this file defines the order of featured posts on the website.
Including Custom Scripts
Note: For security purposes, all scripts referenced are vetted and hosted via our s3 bucket.
If you need to include a custom script for demo purposes, you will need to send the script over to us for review.
# blog post frontmatter
layout: Post
title: David's Amazing Post
scripts:
- https://link-to-custom-js-in-s3-bucket.js
- http://link-to-custom-js-two-in-s3-bucket.js
inlineJS: |
console.log('hi')
console.log('this is a multiline inline JS that will run in the post')Markdown Resources
Our blog posts are written in markdown and support standard Github flavored markdown. If you are new to markdown, don't fret, check out this handy how to guide on writing in markdown
Need a markdown editor? Give stackedit.io, Byword or typora a spin.
Need to convert a Google doc to markdown? Install this chrome extension
Need to convert HTML to markdown? You can use this handy html to markdown converter
Need to convert Word to markdown? You can use this handy Word to Markdown Converter
Recommended Writing Apps
hemingwayapp - Hemingway helps you write with power and clarity by highlighting adverbs, passive voice, and dull, complicated words