Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 2.14 KB

README.md

File metadata and controls

59 lines (37 loc) · 2.14 KB
Raw

DTCG Technical Reports

This directory contains the source code for the Design Token Community Group's (DTCG) technical reports.

Pre-requisites

In order to preview edits locally, you will need the following installed on your machine:

  • Node.js >= 16.8
    • If you use nvm, you can run nvm install to install and use the recommended version of Node.

Initial setup

After cloning this repo, you need to install the dependencies:

npm install

This step does not need to be repeated unless the dependencies are changed.

Local previews

To see live previews of local edits to the technical reports run:

npm run dev

Editing

We use the W3C's ReSpec tool to generate our technical reports. Although knowledge of HTML and Markdown is sufficient for simple edits, we recommend that authors familiarise themselves with ReSpec's features.

To making editing our format specification more convenient and to reduce the likelihood of merge conflicts, we have split out the main chapters into separate Markdown files. The format/index.html then includes them all using ReSpec's data-include feature.

For example:

<section
  data-include="./file-format.md"
  data-include-format="markdown"
></section>

Deployments

Any changes to the source files in this directory that get merged into main are automatically deployed to https://tr.designtokens.org/ via the technical-reports GitHub Action. They are hosted using GitHub Pages and the build output can be found in the gh-pages branch.

Additionally, we use Netlify to generate preview deploys for PRs. Netlify will post a comment to the PR with the URL of the preview once it is ready.