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

Add an option to prevent HTML from being generated #337

Closed
ericjim opened this issue Nov 15, 2016 · 1 comment
Closed

Add an option to prevent HTML from being generated #337

ericjim opened this issue Nov 15, 2016 · 1 comment
Labels
question Question about functionality

Comments

@ericjim
Copy link

ericjim commented Nov 15, 2016

In my current project, I am only relying on the outputted json file to generate documentation. Is there any way to prevent HTML from being generated? I do not use those files. This is somewhat related to #257

@aciccarello
Copy link
Collaborator

You should be able to do this by calling the generateJson method on an Application instance.

It would be something along the lines of

const src = Path.join(__dirname, 'src');
const out = Path.join(__dirname, 'docs.json');
const app = new TypeDoc.Application({
  mode: 'modules',
  out: 'docs',
  theme: 'minimal',
  tsconfig: './tsconfig.json',
});
app.generateJson(app.expandInputFiles([src]), out)

My initial reaction is that this doesn't need to be part of the CLI so I'll close the issue.

@aciccarello aciccarello added the question Question about functionality label Feb 1, 2018
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