@@ -44,6 +44,36 @@ Uses Jinja2 templating.
4444They are pulled from GitHub by just loading
4545whatever URL to our main profile page is.
4646
47+ ###Metadata
48+ Most forums and social networks nowadays can use fancy card views with a
49+ title, a description and an image, which serves as a link preview. For the
50+ card preview to work, the` <head> ` section must include some metadata fields.
51+
52+ The most important fields have been configured for all pages with some
53+ defaults and they can be overwritten from more specific templates. See
54+ ` templates/layout.html ` for info on how to set the metadata and the defaults
55+ used.
56+
57+ ` og_title ` ,` og_description ` and` og_image ` block can be used to modify the default title
58+ description and image in the card respectively. Here is one example from the
59+ teammates template:
60+
61+ ``` html
62+ <!-- layout sets the metadata defaults and blocks to modify it-->
63+ {% extends "layout.html" %}
64+ <!-- Use og_title to modify the default "PyMC Labs" as title-->
65+ <!-- Note that this only affects the card title, not the title shown by the browser-->
66+ {% block og_title %}{{ this.name }} - PyMC Labs{% endblock %}
67+ <!-- Use og_title to modify the default "Bespoke Bayesian Modeling" as description-->
68+ {% block og_description %}{{ this.blurb|string }}{% endblock %}
69+ ```
70+
71+ See more on possible metadata fields[ here] ( https://ogp.me/ ) . Moreover,
72+ Twitter is extremely picky and in addition to being the most restrictive in
73+ general, also requires an extra line to choose between the` summary ` or
74+ ` summary_large_image ` card types. For now all pages use` summary ` format, but
75+ this could be modified or left to configure for each page if desired.
76+
4777###Other stuff to edit?
4878
4979Consult: