carbonplan / research

datasets, models, interactives, and commentary on climate services and solutions

This repository contains our directory of research articles, tools, and commentary. Browse the live version at carbonplan.org/research. All articles and most of our tools are included directly in this repository within the articles and tools subfolders. Some of our more complex tools are in separate repos and hosted independently, for example forest-offests and cdr-database.

The site is a Next.js project, deployed on Vercel.

to build the site locally

Assuming you already have Node.js installed, you can install the build dependencies as:

npm install .

To start a development version of the site, simply run:

npm run dev

and then visit http://localhost:4000/research in your browser.

articles

New articles should be added to articles/ with the article content exported from articles/{article-name}/index.md.

components

Beyond the default set of components available to each article, extra components (e.g. figures and tables) must be configured using the components key in the MDX frontmatter. Any named exports corresponding to the name key will be considered first, followed by the default export.

components:
  - name: ComponentName
    src: ./path/to/component

You may also use components imported from external packages. For example,

components:
  - name: Sun
    src: '@carbonplan/icons'

You may also specify an exportName that is distinct from the name used for reference within MDX. For example,

components:
  - name: ThemedLink
    src: theme-ui
    exportName: Link

To wire through components for availability in MDX, you can start a development version of the site or explicitly run:

npm run build-components

display titles

To override the default formatting of an article title, you may add custom JSX to use for your article in components/mdx/display-titles.js

tools

Tools should be added directly to pages/research/ using the .page.js extension. Entries for tools should be added contents/tools.js to support rendering content on the index page.

publications

Publications can be added as an entry to contents/publications.js.

comments

Comment letters can be added as an entry to contents/comments.js.

additional pages

Additional mdx-built pages are automatically generated when added to articles/{related-article-name}/{additional-page-name}.md. The route will be prefixed with the related article name.

license

All the code in this repository is MIT licensed, but we request that you please provide attribution if reusing any of our digital content (graphics, logo, articles, etc.).

about us

CarbonPlan is a nonprofit organization that uses data and science for climate action. We aim to improve the transparency and scientific integrity of climate solutions with open data and tools. Find out more at carbonplan.org or get in touch by opening an issue or sending us an email.