Skip to content

Commit

Permalink
Merge pull request #9 from gisaia/fix/typedoc
Browse files Browse the repository at this point in the history
Freeze versions of typedoc and typedoc-plugin-markdown
  • Loading branch information
MohamedHamouGisaia authored Jan 3, 2019
2 parents 25be234 + a5d71cc commit de94339
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
4 changes: 2 additions & 2 deletions typedoc-dockerfile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- Mount the project folder as a volume into /docs :

```
docker run --rm -it -v `pwd`:/docs gisaia/typedocgen:0.0.4 generatedoc
docker run --rm -it -v `pwd`:/docs gisaia/typedocgen:0.0.5 generatedoc
```

>Most of the time, your project folder contains a node_modules folder that can be source of troubles while generating the documentation.
Expand All @@ -15,7 +15,7 @@ Please consider in that case applying the following use case:
- If you want to generate documentation from typscript files that are in a specific folder in your project folder :

```
docker run --rm -it -v `pwd`:/docs gisaia/typedocgen:0.0.4 generatedoc relative/path/to/the/specific/folder
docker run --rm -it -v `pwd`:/docs gisaia/typedocgen:0.0.5 generatedoc relative/path/to/the/specific/folder
```

## Generated documentation :
Expand Down
7 changes: 3 additions & 4 deletions typedoc-dockerfile/generate-doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@ rm -rf typedoc_docs
mkdir typedoc_docs

## INSTALL DEPENDENCIES OF THE MOUNTED FOLDER + INSTALL TYPEDOC AND MARKDOWN PLUGIN
yarn install
yarn add typedoc typedoc-plugin-markdown
npm install
npm add typedoc@0.13.0 typedoc-plugin-markdown@1.1.20

## GENERATE THE DOCUMENTATTION
node_modules/.bin/typedoc --mode modules --theme markdown --module es2015 --excludePrivate --out ./typedoc_docs/ --exclude **/*.spec.ts "$1"

## UNINSTALL TYPEDOC AND MARKDOWN PLUGIN, TO REMOVE IT FROM package.json OF THE MOUNTED FOLDER
yarn remove typedoc
yarn remove typedoc-plugin-markdown
npm remove typedoc typedoc-plugin-markdown


## SET THE OWNER OF typedoc_docs TO THE HOST USER
Expand Down

0 comments on commit de94339

Please sign in to comment.