/jama-digest

JAMA Digest

Primary LanguageHTMLMIT LicenseMIT

Welcome to JAMA Digest

You can use the editor on GitHub to maintain and preview the content for your website in Markdown files.

Whenever you commit to this repository, GitHub Pages will run Jekyll to rebuild the pages in your site, from the content in your Markdown files.

How to make a post

  • Put new page under _posts/YYYY folder
    • you can use .md or .html format
    • filename should be in format: YEAR-MONTH-DAY-title (more info here)
    • add standard Front Matter header to you page (even if it is an html page)
      • it should have 'layout: default' item in order to use default template for post page.
      • other headers are optional
  • If you want to include image:
    • place it in '/assets/posts/YYYY' folder
    • it is better to name it with prefix MONTH-DAY that match the date of the post - so that it is easier to find related page
    • add link to it on your post page
    • prefix link with '{{site.baseurl}}' so that it is correctly resolved on published site. (More info about templating)

Markdown basics

Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for

Syntax highlighted code block

# Header 1
## Header 2
### Header 3

- Bulleted
- List

1. Numbered
2. List

**Bold** and _Italic_ and `Code` text

[Link](url) and ![Image](src)

For more details see GitHub Flavored Markdown.

Another tutorial on Basic writing and formatting syntax

Jekyll Themes

Your Pages site will use the layout and styles from the Jekyll theme you have selected in your repository settings. The name of this theme is saved in the Jekyll _config.yml configuration file.