About the Foundation for Public Code

How to write a resource

This guide


  1. Anatomy of a resource
    1. Metadata
    2. Name of the resource
    3. Content
      1. Adding templates
    4. Further reading section
    5. Example resources

Resources are packets of reusable information. They are the main way we store information.

Resources are shared truths in the Foundation for Public Code that everyone can work from.

Anatomy of a resource


The MarkDown of a resource file starts with the following metadata front-matter:

type: Resource

Name of the resource

Followed by the name of the resource:

# Rationale for why spaghetti is the most superior food


Followed by the content of the resource.

Adding templates

For templates you can use code blocks. You can make a Markdown codeblock opened by:


and closed by:


If you want to indicate where things need to be filled in you can use curly braces, { and }, to show where the content can be added. Curly braces are preferred over square brackets since they do not clash with markdown syntax and over normal brackets as they stand out more.

Further reading section

At the end of your resource you can add a ‘Further reading’ section with relevant links to help people understand this topic or our rationale better.

## Further reading

* [Find great cat gifs on Giphy](https://giphy.com)
* [Find great dog videos on YouTube](https://youtube.com)

Example resources