Skip to content

Latest commit

 

History

History
110 lines (70 loc) · 4.39 KB

README.md

File metadata and controls

110 lines (70 loc) · 4.39 KB
Raw

The Hugging Face Blog Repository 🤗

This is the official repository of the Hugging Face Blog.

If you are an external contributor: If your blog post is not a collaboration post with Hugging Face, please consider creating a community blog instead. Community blog posts appear on our blogs main page just like the blogs in this repository.

How to write an article? 📝

1️⃣ Create a branch YourName/Title

2️⃣ Create a md (markdown) file, use a short file name. For instance, if your title is "Introduction to Deep Reinforcement Learning", the md file name could be intro-rl.md. This is important because the file name will be the blogpost's URL.

3️⃣ Create a new folder in assets. Use the same name as the name of the md file. Optionally you may add a numerical prefix to that folder, using the number that hasn't been used yet. But this is no longer required. i.e. the asset folder in this example could be 123_intro-rl or intro-rl. This folder will contain your thumbnail only. The folder number is mostly for (rough) ordering purposes, so it's no big deal if two concurrent articles use the same number.

For the rest of your files, create a mirrored folder in the HuggingFace Documentation Images repo. This is to reduce bloat in the GitHub base repo when cloning and pulling.

🖼️: In terms of images, try to have small files to avoid having a slow loading user experience:

4️⃣ Copy and paste this to your md file and change the elements

  • title
  • thumbnail
  • authors
---
title: "PUT YOUR TITLE HERE" 
thumbnail: /blog/assets/101_decision-transformers-train/thumbnail.gif
authors:
- user: your_hf_user
- user: your_coauthor
---

# Train your first Decision Transformer

Your content here [...]

When published, the Hub will insert the following UI elements right after the blogpost's main header (i.e. the line that starts with a single #, aka. the <h1>):

  • "Published on [date]"
  • "Update on GitHub" button
  • avatars of the authors that were listed in authors.

5️⃣ Then, you can add your content. It's markdown system so if you wrote your text on notion just control shift v to copy/paste as markdown.

6️⃣ Modify _blog.yml to add your blogpost.

7️⃣ When your article is ready, open a pull request.

8️⃣ The article will be published automatically when you merge your pull request.

How to get a nice responsive thumbnail?

1️⃣ Create a 1300x650 image

2️⃣ Use this template and fill the content part.

➡️ Or select a background you like and follow the instructions in this Figma template.

Using LaTeX

Just add:

\\(your_latex_here\\)

For instance:

\\( Q(S_t, A_t) \\) ➡️ $Q(S_t, A_t)$

How to Caption Figures

A couple of alternatives:

How to Use Highlight Boxes

See an example in this PR. This is to be used sparingly :)

Embed a Space

Just add:

<script
	type="module"
	src="https://gradio.s3-us-west-2.amazonaws.com/4.36.1/gradio.js"
></script>

<gradio-app theme_mode="light" space="derek-thomas/hugging-face-blog-assistant"></gradio-app>

Code: leaderboard-bigcodebench.md Blog Example

More Assistance

You can use the community blog editor which has a preview function.

Or check out this assistant space to help with rendering some tricky markdown blocks like:

  • Inserting caption figures with image tables
  • Tip formatting
  • Inserting clickable references

Do give it a like if it was helpful.