# serverless-blog

**Repository Path**: yunwisdoms/serverless-blog

## Basic Information

- **Project Name**: serverless-blog
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-02-28
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# [Serverless Blog](https://serverless.com/blog/)

<a href="https://www.youtube.com/watch?v=ps1oQeg-0ss" target="_blank"><img align="right" width="411" height="241" src="https://cloud.githubusercontent.com/assets/532272/23035035/bb26026c-f432-11e6-9338-a603b8cb32b4.png"></a>

Welcome to the serverless blog repo! [Contributions, typo fixes and pull requests are welcome](https://github.com/serverless/blog/new/master/post) :thumbsup:

## Table of Contents
<!-- ⛔️ AUTO-GENERATED-CONTENT:START (TOC:collapse=true&collapseText=Click to expand) -->
<details>
<summary>Click to expand</summary>

- [How to contribute content](#how-to-contribute-content)
  * [1. Write your content in markdown!](#1-write-your-content-in-markdown)
  * [2. Name your post file name](#2-name-your-post-file-name)
  * [3. In your post, include post meta information:](#3-in-your-post-include-post-meta-information)
- [Post Heading](#post-heading)
- [Post SubSection](#post-subsection)
  * [4. Add your author bio](#4-add-your-author-bio)
  * [5. Submit a PR to the repository](#5-submit-a-pr-to-the-repository)
  * [6. (optional) Preview your post](#6-optional-preview-your-post)
- [Including Custom Scripts](#including-custom-scripts)
- [Markdown Resources](#markdown-resources)
- [Recommended Writing Apps](#recommended-writing-apps)

</details>
<!-- AUTO-GENERATED-CONTENT:END -->

## [How to contribute content](https://www.youtube.com/watch?v=ps1oQeg-0ss)

### 1. Write your content in markdown!

> New to markdown? [Read this](https://guides.github.com/features/mastering-markdown/)

> Need Content ideas? [Read this](./writers-guide.md)

---

### 2. Name your post file name

`YYYY-MM-DD-blog-post-name.md` :point_right: `2016-01-27-post-title-here.md`

> [handy tool for slugifying titles](https://blog.tersmitten.nl/slugify/)

---

### 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:

<pre>
# 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')
```
</pre>

> Questions about formatting? [See a complete post example](https://raw.githubusercontent.com/serverless/blog/master/posts/2016-10-25-building-a-serverless-garden.md)

---


### 4. Add categories

Choose appropriate categories for the blog post from the list of categories available [here](./categories.json). 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.

```yml
---
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.

```yml
---
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](https://github.com/serverless/blog/new/master/post) or submit a PR.

**External contributors**

> Fork this repo and submit a PR. [This video guide will walk you through the process](https://www.youtube.com/watch?v=ps1oQeg-0ss)

We will review and publish your post with our audience on [serverless.com](https://serverless.com/blog/) and share it all around the web!

Ping us with any questions on [Twitter](http://twitter.com/goserverless) or [post an issue](https://github.com/serverless/blog/issues/new) 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](https://github.com/serverless/site#quick-start), installing the dependencies and running `npm start`.

---

## Updating featured posts

The file [featured-blogs.json](./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.

```yml
# 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](https://guides.github.com/features/mastering-markdown/). If you are new to markdown, don't fret, check out this handy [how to guide on writing in markdown](https://blog.ghost.org/markdown/)

Need a markdown editor? Give [stackedit.io](https://stackedit.io/editor), [Byword](https://bywordapp.com/) or [typora](https://www.typora.io/) a spin.

Need to convert a Google doc to markdown? [Install this chrome extension](https://chrome.google.com/webstore/detail/export-as-markdown/hbojhdcnbcondcdfpfocpkjkfkbnbdad)

Need to convert HTML to markdown? You can use [this handy html to markdown converter](https://domchristie.github.io/to-markdown/)

Need to convert Word to markdown? You can use [this handy Word to Markdown Converter](https://word-to-markdown.herokuapp.com/)

## Recommended Writing Apps

[hemingwayapp](http://www.hemingwayapp.com/desktop.html) - Hemingway helps you write with power and clarity by highlighting adverbs, passive voice, and dull, complicated words