Git Product home page Git Product logo

blog's Introduction

Welcome to the serverless blog repo! Contributions, typo fixes and pull requests are welcome 👍

Table of Contents

Click to expand

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

handy tool for slugifying titles


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


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

blog's People

Contributors

ac360 avatar adnanrahic avatar alaskacasey avatar alexdebrie avatar andrea-p avatar asanka-x avatar davidwells avatar devilrancy avatar douweh avatar eahefnawy avatar flomotlik avatar goncaloneves avatar horike37 avatar j0k3r avatar karloscodes avatar laardee avatar marcy-terui avatar mootrichard avatar nicka avatar plfx avatar pmuens avatar razzius avatar rupakg avatar schickling avatar shekhargulati avatar sid88in avatar sorenbs avatar stefmonge avatar victor-stone avatar worldsoup avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.