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.

Sign up for GitHub

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

Jump to bottom

Feature doc improvements #40

Merged
merged 8 commits into from
May 19, 2019
Merged

Feature doc improvements #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4eee96e
Change in ci config to test docs
thefill May 19, 2019
01a7bd0
Change in ci config to test docs
thefill May 19, 2019
7025e78
Change in ci config to test docs
thefill May 19, 2019
7d978f7
Change in ci config to test docs
thefill May 19, 2019
8a6ae39
Change in ci config to test docs
thefill May 19, 2019
31401ac
Change in ci config to test docs
thefill May 19, 2019
5996890
Change in ci config to test docs
thefill May 19, 2019
c3db2cd
Change in ci config to test docs
thefill May 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,11 @@ jobs:
command: |
npm run docs

- run:
name: Verify
command: |
sed -e '/<\/body>/r src/docs-partials/api-docs.style.html' -e '//N' docs/archive/0.0.3/index.html

- run:
name: Publish docs
command: |
Expand All @@ -149,6 +154,7 @@ jobs:

workflows:
version: 2

build-test:
jobs:
- setup:
Expand Down
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jetli",
"version": "0.0.3",
"version": "0.0.4",
"description": "Dependency injector",
"main": "dist/cjs/index.js",
"module": "dist/esm/index.js",
Expand Down Expand Up @@ -28,8 +28,8 @@
"docs:api-readme": "concat -o API-README.md BASE-README.md src/docs-partials/readme.api-documentation.md",
"docs:html": "typedoc --mode modules --exclude \"**/*+(index|.spec|.e2e).ts\" --tsconfig tsconfig.esm.json --hideGenerator --readme API-README.md --out docs/archive/$npm_package_version src",
"docs:postprocess": "run-s docs:html-style docs:html-script && cp -R docs/archive/$npm_package_version/* docs/",
"docs:html-style": "sed -e '/<\\/head>/r src/docs-partials/api-docs.style.html' -e '//N' docs/archive/$npm_package_version/index.html > docs/archive/$npm_package_version/index.html.tmp && mv docs/archive/$npm_package_version/index.html.tmp docs/archive/$npm_package_version/index.html",
"docs:html-script": "sed -e '/<\\/body>/r src/docs-partials/api-docs.script.html' -e '//N' docs/archive/$npm_package_version/index.html > docs/archive/$npm_package_version/index.html.tmp && mv docs/archive/$npm_package_version/index.html.tmp docs/archive/$npm_package_version/index.html",
"docs:html-style": "sed -i.bak -e '/main\\.css/r src/docs-partials/api-docs.style.html' -e '//N' docs/archive/$npm_package_version/index.html && rm docs/archive/$npm_package_version/index.html.bak",
"docs:html-script": "sed -i.bak -e '/<\/script>/r src/docs-partials/api-docs.script.html' -e '//N' docs/archive/$npm_package_version/index.html && rm docs/archive/$npm_package_version/index.html.bak",
"clean": "run-p clean:build clean:docs clean:test",
"clean:build": "rimraf dist",
"clean:docs": "rimraf docs && rimraf .cache && rimraf BASE-README.md && rimraf API-README.md",
Expand Down