Skip to content

Publishing News

Isaac edited this page Jul 23, 2026 · 3 revisions

News posts are Markdown files grouped by language in _articles/. The filename becomes part of the public address. For example, _articles/en-us/example-update.md becomes /article/example-update.

Prepare the article

Create an article

Add a Markdown file such as _articles/en-us/example-update.md:

---
layout: news
lang: en-us
title: "Example update"
date: 2026-07-22
author: exampleperson
banner: /assets/img/example-banner.png
summary: "A concise description of the update."
type: "NEWS"
featured: false
---

An opening paragraph that explains the update.

## What changed?

The details of the announcement.

The block between the --- lines is the article's front matter. It gives Jekyll the information needed to display and list the article.

The fields mean:

Field Requirement
layout Must be news.
lang Must match the containing language folder, such as en-us or zh-cn.
title A useful article title. Quote it if punctuation could confuse YAML.
date Publication date in an unambiguous YAML date format.
author The author's short identifier from _data/staff.yml, not their display name.
banner An image path beginning with /; the image file must already exist.
summary A short description used on article cards, search results, and link previews.
type A category label such as NEWS.
featured Optional. Use true to show the article in the featured section, or false not to.

Author records

The author value is a stable staff identifier, not the person's display name:

author: petermazep

The site uses that identifier to find the author's details in _data/staff.yml. If the identifier is misspelled or missing, the automated checks will fail.

Publication and links

Add the translated article

Create a file with the same filename in every supported language folder:

_articles/en-us/example-update.md
_articles/zh-cn/example-update.md

The Chinese file declares lang: zh-cn and translates the title, summary, and body. Keeping the filename identical lets Polyglot connect the translations. See Localization for the complete article translation rules.

Article listings

The article appears automatically on the news page and sitemap. You do not need to add it to those pages by hand.

URL stability

With the filename _articles/en-us/example-update.md, the public routes are:

/article/example-update
/zh-cn/article/example-update

Do not rename a published article file without asking a maintainer. Renaming it breaks the old address, including bookmarks and previously shared links.

Verify the article

Before publishing

  • Confirm the language, title, date, author, summary, category, and banner.
  • Preview both language versions and confirm the language switcher stays on the article.
  • Check that statements about projects in development are factual and approved.
  • Preview the article page and its card on /articles.
  • Make sure headings begin with ## in the article body; the page layout creates the main heading.
  • Run all commands in Testing and Deployment.

Next: Styling and Interactions

Clone this wiki locally