Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

building typedoc #40

Closed
vclteam opened this issue Oct 21, 2014 · 1 comment
Closed

building typedoc #40

vclteam opened this issue Oct 21, 2014 · 1 comment
Labels
question Question about functionality

Comments

@vclteam
Copy link

vclteam commented Oct 21, 2014

hi

how can i build typedoc from source?

@sebastian-lenz
Copy link
Member

Hi, you can compile TypeDoc using the included Gruntfile. You'll need Node.js and Grunt installed.

  1. Download and install Node.js from their Website
  2. Install Grunt CLI npm install -g grunt-cli
  3. Clone and checkout the TypeDoc repro and chdir into your workingdir
  4. Install the required build debendencies by running npm install

Now you should be able to build TypeDoc by running grunt within the workingdir. The compiled files will be placed in the bin directory. To build the assets of the themes you can run grunt theme.

Hope that helps, let me know if it's working for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

2 participants