README.md

DEPRECATED

TypeDoc's site (https://typedoc.org) is now generated with the site folder in the main repository. See https://github.com/TypeStrong/typedoc/tree/master/site

---

TypeDoc homepage

Holds the contents of https://typedoc.org. GitHub pages renders the website from the gh-pages branch, using the _site/ folder.

Reporting Issues

Please report issues to the TypeStrong/typedoc repo for better visibility.

Writing guides

Guides are stored in the guides/ directory and written in Markdown. Each file should contain the following header section with an appropriate title and menu order.

---
layout: 'guide'
title: 'Installation'
menuOrder: 1
---

Building the site locally

git clone https://github.com/TypeStrong/typedoc.git
npm i
npm run prebuild # serve doesn't do this as it takes a bit
npm run serve

To regenerate the _site/api/ folder, go to the root directory of typedoc-site and clone the typedoc repo (the typedoc folder is in .gitignore). Then run:

cd typedoc
npm i
npm run build
node bin/typedoc --options ../typedoc.json

To regenerate the _site/example/ folder:

cd typedoc/example
npm i
node ../bin/typedoc --options ../../example.typedoc.json

If new options have been added since the last update, run the following to update the typedoc.json schema:

node typedoc/scripts/generate_options_schema.js _site/schema.json