This folder contains Markdown files for individual posts populating the News page.
To create a new post, we recommend copying an existing post as close to the formatting, structure, or features you want and renaming it in the following hyphenated format: YYYY-MM-DD-key-words.md
.
Note:
- Posts can be back- or future-dated, but must use a four-digit year and two-digit month and day.
key-words
serve only to differentiate posts with the same date, so keep to a maximum of three (3).- Publications should follow
pub-journal-lastname
, with the ADS journal abbreviation forjournal
and first author forlastname
(see existing posts for examples). - To avoid URL conflicts, append
-#
(where # is unique) to publication posts with the samepub-journal-lastname
, even if they are prepended with differentYYYY-MM-DD-
dates.
- Publications should follow
- See Working with Posts for more basic information.
- For post ideas and examples, see this extensive list of rendered Sample Posts and their corresponding raw Markdown files.
Each file must contain a YAML front matter block at the top, sandwiched between triple-dashed lines (---
), for Jekyll to process.
Below is a generic example, followed by a key legend subsection:
---
title: "Nature Publication"
last_modified_at: 2016-03-09T18:20:02-08:00
categories:
- Publications
tags:
- protoplanetary disks
- planet formation
- fluid dynamics
---
-
title:
The title (wrapped in double quotes) to be displayed in the News list, at the top of the post's page itself, and in any relevant search results. -
last_modified_at:
(Optional) The date and time of last modification, formatted asYYYY-MM-DDTHH:MM:SS-HH:MM
, where the times followingT
is the 24-hour UTC time$\pm$ the offset (e.g.,-08:00
for PST) -
categories:
A single term (e.g.,Publications
orPress
) to categorize your post; see Posts by Category for an existing list. -
tags:
Multiple, unlimited entries (each on a separate line) to identify relevant keywords or topics and relate to other tagged posts; be sure to include relevant team members in- Lastname, Firstname
format; see Posts by Tag for an existing list. -
[other]:
Posts support additional front matter flags (options) for various features and scenarios; see the Jekyll's documentation on Posts, and this extensive list of rendered Sample Posts and their corresponding raw Markdown files, for more information.
Jekyll will render your post from any Markdown you supply below the front matter section. Specifically, our site supports GitHub Flavored Markdown (GFM) input, which includes some extensions beyond the standard Markdown specification, notably fenced code blocks.
- For a GFM reference and more information on Markdown formatting and features, see Writing on GitHub.
- For additional post ideas and examples, see this extensive list of rendered Sample Posts and their corresponding raw Markdown files.
- See also GitHub Learning Lab's, 10 step, 45 min course on Communicating using Markdown.