Créer et partager un composant de thème de police

Discourse supports importing themes containing assets from a remote repository.

This allows theme authors to share fonts and images.

Create a new git repository with the font

mkdir discourse-roboto-theme
cd discourse-roboto-theme
git init .
vim about.json

For about.json add a skeleton config file

{
  "name": "Roboto theme component",
  "about_url": "",
  "license_url": "",
  "assets": {
    "roboto": "assets/roboto.woff2"
  }
}

Add a LICENSE file, I usually use MIT

vim LICENSE

Download the font

http://localfont.com/ is a handy site to get fonts

mkdir assets
cp ~/Downloads/roboto.woff2 roboto.woff2

Add CSS that consumes the theme

mkdir common
cd common

Create a file called common.scss with

@font-face {
  font-family: Roboto;
  src: url($roboto) format("woff2");
}

body {
  font-family: Roboto;
}

Push changes to GitHub

Check in all your changes:

git add LICENSE
git add about.json
git add assets/roboto.woff2
git add common/common.scss
git commit -am "first commit"

Create an account on GitHub.com and then create a new repository.

(Optional) create a topic on Discourse as a home to discuss your colors

Ideally you would create a topic in the #plugin:theme category with some screenshots of your color scheme. You will use this as your about_url

Fill in the missing information in your about.json file

  • Navigate to your LICENSE page on GitHub, fill in that URL as your license_url

  • Either use the GitHub project URL or Discourse topic URL as your about_url

At the end of the process your about.json file will look something like:

{
  "name": "Roboto theme component",
  "about_url": "https://github.com/SamSaffron/discourse-roboto-theme",
  "license_url": "https://github.com/SamSaffron/discourse-roboto-theme/blob/master/LICENSE",
  "assets": {
    "roboto": "assets/roboto.woff2"
  }
}

Check in the change and push to GitHub

git commit -am "added more details"
git push

Test your font component

  • In the admin/customize/theme screen import your theme from GitHub

:confetti_ball:

You can now easily share fonts!

See also:


This document is version controlled - suggest changes on github.

19 « J'aime »

Great tutorial.

Worked like a charm except it looks like localfont.com is down or no more.

I used this Google webfonts helper site to download a .woff2 version of the font I was after.

See also Discourse Theme CLI (console app to help you build themes)

1 « J'aime »

Lorsque j’ai suivi les étapes, j’ai reçu une Erreur : Variable non définie : « $fontname ».

Donc :
J’ai déclaré la variable dans $variables :
fontname: "assets/fontname.woff2";

Il me semble que vous devez la remplir, mais quel chemin utiliser dans les $variables ?

Lorsque vous laissez Discourse télécharger les fichiers avec

"assets": {
        "fontname": "assets/fontname.woff2"
   }

il télécharge le fichier vers un autre chemin que assets/roboto.woff2, semble-t-il
(/uploads/db0202/original/1X/...)

Modification :
Pas besoin de $variables, la magie opère avec les téléchargements. Mais j’avais assets/font.svg#regular dans les assets et le hashtag a créé le problème.

2 « J'aime »

J’obtiens la même erreur Erreur : Variable indéfinie. Et aussi, aucun fichier n’est affiché dans les téléchargements ou le téléchargement en tant que titre.

Ce tutoriel doit-il être mis à jour ?

Merci d’avance.

1 « J'aime »