Skip to content
This repository was archived by the owner on Dec 18, 2018. It is now read-only.

Blog Post Guide

Jump to bottom
Tom Norton edited this page Nov 10, 2017 · 2 revisions

Procedure for Writing a New Blog Post

  1. add the file to the blog directory
  2. add the filename as an entry in blog/menu.md

A blog post is written in standard Markdown with the figure extensions, like normal documentation pages.

There is one small caveat:

In order for the author to correctly display, a small amount of inline HTML needs adding under the primary title. Here is an example from the first page:

# Version 8.6.0 Released

<p id="publish-data">By Tom Norton - 14th July 2017</p>

---

Today we're happy to announce the release of Webots 8.6.0. This new release brings a ton of new features and improvements, coupled with the same dedicated patches addressing bugs and regressions. Listed below are some of the key features of this release (for a full list of changes please refer to the ChangeLog, found [here](https://www.cyberbotics.com/dvd/common/doc/webots/ChangeLog.html)).

This guarantees that the Blog CSS can position the element correctly on the blog post.

Youtube videos can be embedded using this syntax:

![youtube video](https://www.youtube.com/watch?v=S0k0cJb_Mus)

Style Guide

  1. The page title should be done with an h1 (i.e. "# Webots 2019c Released"). Section titles and further sub-titles should follow h2(##), h3(###) etc.

  2. Between each section that starts with an h2, a horizontal rule should be placed, like this: ---

  3. Prefer either HTML5 video or YouTube videos to GIFs for animated content.

  4. Any screenshots should be of the highest quality & size possible. This includes enabling graphical features such as anti-aliasing, high-quality texture filtering, shadows etc.

Clone this wiki locally