Skip to content

Instantly share code, notes, and snippets.

@ultim8k
Created November 20, 2015 12:16
Show Gist options
  • Save ultim8k/3f8e741d375a3206646b to your computer and use it in GitHub Desktop.
Save ultim8k/3f8e741d375a3206646b to your computer and use it in GitHub Desktop.
Hello!

Hevnly Magazine

aka HHG

How to post

  1. You can read about markdown syntax in markdown cheatsheet, but generally you will need these:
  • *italics*
  • **bold**
  • [link name](http://link.com)
  • ![image alt text](image-file-name.jpg)
  • >Quote text
  • - bullet list item
  • 1. numbered list item
  1. Write your article using a markdown editor or even a simple note editor (except ms notepad). A useful one is stackedit.

  2. Images should be named with lowercase latin characters, numbers and dashes. They should not contain capitals, spaces or any special character like

    !¡@#™€¢∞§¶•ªº–≠$£%^&*()[]{}<>_+=.,:;'"?/|\\`~
    

    Images should be placed in:

    /source/images/**EDITION_NUMBER**/**POST-SLUG**/ .
    

    For example if my post is named Foo Bar and belongs to the 5th edition, it should go in:

    /source/images/5/foo-bar/
    
  3. At the top of your markdown file add some useful metadata:

    ---
    title: "How to post in hevnly magazine"
    subTitle: "Also known as HHG"
    readingTime: 4min
    heroImage: hhg-post-hero.jpg
    date: 2015-11-20
    slug: hhg-post
    tags: markdown, blog, magazine, metadata 
    category: product
    editionName: posting
    editionNumber: 1
    ---
    
  4. Save your markdown file using the following naming convention:

    POST_DATE + POST_SLUG + .md
    

    eg

    2015-10-21-back-to-the-future.md
    

Thanks!

I am the best!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment