forked from ng-doc/ng-doc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(add): add an explanation for the
@ng-doc/generated
path
Closes ng-doc#112
- Loading branch information
1 parent
50f691a
commit d935d60
Showing
4 changed files
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
> **Warning** | ||
> TypeScript may display an error for the `@ng-doc/generated` path in your code editor if you are | ||
> using the library for the first time. Files for the `@ng-doc/generated` path will be generated | ||
> automatically when you run your application, so please disregard any errors related to it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics'; | ||
|
||
/** | ||
* | ||
*/ | ||
export function postInstall(): Rule { | ||
return async (tree: Tree, context: SchematicContext) => { | ||
context.logger.info( | ||
`[INFO]: Everything is done! Files for the "@ng-doc/generated" path will be created when you start your application.`, | ||
); | ||
}; | ||
} |