Edit on GitHub

Writing Blog Posts

To create a new post, you need to create a PR to the DVC website project.

Prepare your environment

Set up the Development environment to see how your content will look like after you publish it. In the yarn develop mode you will be able to run the website locally, and it'll be updating content in your browser as you edit the post.

Add a post

Create a Markdown file in the content/blog folder. File name must follow the pattern: YYYY-MM-DD-my-new-blog-post.md. After merging this file into the master branch, blog post will be published at blog/my-new-blog-post address automatically.

Write front matter in the following format:

---
title: Hello World
date: 2015-05-01
description: Hello World
descriptionLong: |
  Some long
  multiline
  text (supports _basic_ [Markdown](link))
picture: 2015-05-01/post-image.jpeg
pictureComment: Some _Comment_ (supports _basic_ [Markdown](link))
author: author_filename
tags:
  - Open Source
  - Machine Learning
  - Data Science
  - Version Control
  - AI
---
  • title - Required. Title of the post.
  • date - Required. Publication date in the YYYY-MM-DD format. Will be used to sort posts and in RSS.
  • description - Required. Short description to show in the feed.
  • descriptionLong - Optional long description to show before the image on the post page. If not set, description will be used instead. Supports basic Markdown markup.
  • picture - Optional cover image, relative to static/uploads/images
  • pictureComment - Optional cover image comment. Supports basic Markdown markup.
  • author - Required. The name of the file in content/authors representing this post's author. See Adding authors to add a new author.
  • commentsUrl - Optional link to the DVC forum topic. It will contain comments for the post.
  • tags - Optional list of tags.

Content guidelines

It's recommended to follow all the relevant recommendations from the Doc style guidelines.

Adding images

๐Ÿ™ Please, be reasonable about the size of the image files you are about to commit โ€” run an online image optimizer. Huge images pollute the Git index, slow down git clone, deployment, and other operations in the repository.

The original image should be 2x the height and width of the size you want to see on the screen, to look sharp. To add images, put them into static/uploads and reference them like this:

![](/uploads/images/2020-02-10/image.png)

To add a subtitle:

![](/uploads/images/2020-02-10/image.png)_subtitle [with a link](link)_

To set the image size and text wrap:

![](/uploads/images/2020-02-10/image.png '=500')
![](/uploads/images/2020-02-10/image.png '=500 Some Title')
![](/uploads/images/2020-02-10/image.png 'Some Title =500')
![](/uploads/images/2020-02-10/image.png 'Some Title :wrap-left =500')
![](/uploads/images/2020-02-10/image.png ':wrap-left =500 Some Title')

Any URLs supported by gatsby-remark-embedder such as Youtube and Twitter share links will be embedded automatically. You just need to paste them in the post Markdown, for example:

... Check out this great video right here:

https://youtu.be/4h6I9_xeYA4

And now lets move onto ...

You can ember a preview of any other website using <external-link> tag:

... Check out this great project:

<external-link
href="https://dvc.org/doc"
title="Open-source tools to version control Machine Learning models and experiments"
description="AI and ML are becoming an essential part of the engineering..."
link="dvc.org"
image="/uploads/images/image.png" />

And now lets move onto ...

Adding authors

Create .md file in the content/authors folder.

Write front matter in the following format:

name: John Doe
avatar: avatar.jpeg
link: https://www.twitter.com/johndoe
  • name โ€“ Required. Author's name.
  • avatar - Required. Path to the author's avatar, relative to static/uploads/avatars (1024x1024 is recommended).
  • link - Optional location that the author's name will link to.
Content

๐Ÿ› Found an issue? Let us know! Or fix it:

Edit on GitHub

โ“ Have a question? Join our chat, we will help you:

Discord Chat