• this repo == MULTIPLE packages

• stack
  • yarn workspaces
  • Node v13+
  • watchman
  • debug
    • if you want to get verbose logs -> env DEBUG="*" yarn test

• yarn install
  
  # Then:
  yarn bootstrap
  
  # Optional, grab the translations:
  yarn docs-sync pull microsoft/TypeScript-Website-localizations#main 1
  
  # start up the website
  yarn start

• | browser,
  • "8000"

• AUTOMATICALLY

  • pushes | branch v2 -> deploy | staging
  • | Monday,
    • v2 branch -> deployed | production

• build logs

• website repo itself
• documentation packages

The main website for TypeScript, a Gatsby website which is statically deployed. You can run it via:

yarn start

To optimize even more, the env var NO_TRANSLATIONS as truthy will make the website only load pages for English.

The editor aspect of the TypeScript Playground REPL, useable for all sites which want to show a monaco editor with TypeScript or JavaScript code.

The JS code has an AMD module for the playground which is loaded at runtime in the Playground website.

• == tools + scripts /

  • generate a TSConfig JSON file's API reference -- via --

    yarn workspace tsconfig-reference build

  • scripts

    # Generate JSON from the typescript cli
    yarn workspace tsconfig-reference run generate-json
    # Jams them all into a single file
    yarn workspace tsconfig-reference run generate-markdown

    • validate the docs

      yarn workspace tsconfig-reference run test
      
      # or to just run the linter without a build
      yarn workspace tsconfig-reference run lint
      
      # or to just one one linter for a single doc
      yarn workspace tsconfig-reference run lint resolveJson

• history
  • ORIGINALLY,
    • microsoft/TypeScript-Handbook
  • AFTERWARD,
    • microsoft/TypeScript-New-Handbook
  • NOWADAYS,
    • updated -- for -- Twoslash

• Playground's user-facing documentation

• TODO: Most of these packages use tsdx.

A code sample markup extension for TypeScript

• Available on npm: @typescript/twoslash

A comprehensive way to run TypeScript projects in-memory in a browser or node environment

• Available on npm: @typescript/vfs

A template for generating a new playground plugin which you can use via npm init playground-plugin [name]

Generates contribution JSON metadata on who edited handbook pages.

A web worker which sits between the Playground and Monaco-TypeScript

• Admin
  • | Prod
    • Azure Portal
    • Deploy logs
    • App Insights
• TypeScript-Website's localizations

• Contributor License Agreement (CLA)