Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Global19/typedoc-site

 
 

Repository files navigation

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

npm i
npm run build --serve

To regenerate the _site/api/ folder, clone the typedoc repo here, and then run:

cd typedoc
npm i
npm run build
node bin/typedoc --options ../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

About

Website for TypeDoc

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 72.3%
  • HTML 15.3%
  • JavaScript 12.4%