Skip to content

Commit

Permalink
Merge pull request #88 from fsegurai/development
Browse files Browse the repository at this point in the history
README improvement
  • Loading branch information
fsegurai authored Nov 29, 2024
2 parents f2655ec + b7cf0d9 commit 6fc2888
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 53 deletions.
14 changes: 7 additions & 7 deletions .github/workflows/release-demo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,13 @@ jobs:
name: ${{ env.ARTIFACT_NAME }}
path: ${{ vars.DEMO_PATH }}

- name: Deploy to gh-pages branch
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ${{ vars.DEMO_PATH }}
publish_branch: gh-pages
force_orphan: true
# - name: Deploy to gh-pages branch
# uses: peaceiris/actions-gh-pages@v4
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: ${{ vars.DEMO_PATH }}
# publish_branch: gh-pages
# force_orphan: true

- name: Setup Pages
uses: actions/configure-pages@v5
Expand Down
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@
- [Mermaid](https://mermaid-js.github.io/) for diagrams and charts visualization
- [Clipboard.js](https://clipboardjs.com/) to copy code blocks to clipboard

Demo available @ [https://fsegurai.github.io/ngx-markdown](https://fsegurai.github.io/ngx-markdown)

### Table of contents

- [Installation](#installation)
Expand Down Expand Up @@ -329,7 +327,7 @@ public options: KatexOptions = {
To add [Mermaid](https://mermaid-js.github.io/) library to your `package.json` use the following command.

```bash
npm install mermaid@^11.4.0 --save
npm install mermaid@^11.4.1 --save
```

To activate [Mermaid](https://mermaid-js.github.io/) diagramming and charting tool you will need to include...
Expand Down Expand Up @@ -1001,7 +999,7 @@ When using variable binding you can optionally use `language` pipe to specify th

A demo is available @ [https://fsegurai.github.io/ngx-markdown](https://fsegurai.github.io/ngx-markdown) and its source code can be found inside the `demo` directory.

It's important to mention that for this project I'm using Node.js v18.20.4 and Yarn v1.22.22.
It's important to mention that for this project I'm using Node.js v20.11.1 and Yarn v1.22.22.

The following commands will clone the repository, install npm dependencies and serve the application @ [http://localhost:4200](http://localhost:4200)

Expand Down
45 changes: 3 additions & 42 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3233,13 +3233,6 @@
"@types/d3-transition" "*"
"@types/d3-zoom" "*"

"@types/dompurify@^3.0.5":
version "3.0.5"
resolved "https://registry.yarnpkg.com/@types/dompurify/-/dompurify-3.0.5.tgz#02069a2fcb89a163bacf1a788f73cb415dd75cb7"
integrity sha512-1Wg0g3BtQF7sSb27fJQAKck1HECM6zV1EB66j8JH9i3LCjYabJa0FSdiSgsD5K/RbrsR0SiraKacLB+T8ZVYAg==
dependencies:
"@types/trusted-types" "*"

"@types/eslint-scope@^3.7.7":
version "3.7.7"
resolved "https://registry.yarnpkg.com/@types/eslint-scope/-/eslint-scope-3.7.7.tgz#3108bd5f18b0cdb277c867b3dd449c9ed7079ac5"
Expand Down Expand Up @@ -3411,7 +3404,7 @@
dependencies:
"@types/node" "*"

"@types/trusted-types@*", "@types/trusted-types@^2.0.7":
"@types/trusted-types@^2.0.7":
version "2.0.7"
resolved "https://registry.yarnpkg.com/@types/trusted-types/-/trusted-types-2.0.7.tgz#baccb07a970b91707df3a3e8ba6896c57ead2d11"
integrity sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw==
Expand Down Expand Up @@ -5255,11 +5248,6 @@ domhandler@^5.0.2, domhandler@^5.0.3:
dependencies:
domelementtype "^2.3.0"

"dompurify@^3.0.11 <3.1.7":
version "3.1.6"
resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-3.1.6.tgz#43c714a94c6a7b8801850f82e756685300a027e2"
integrity sha512-cTOAhc36AalkjtBpfG6O8JimdTMWNXjiePT2xQH/ppBGi/4uIpmj8eKyIkMJErXWARyINV/sB38yf8JCLF5pbQ==

dompurify@^3.2.1:
version "3.2.1"
resolved "https://registry.yarnpkg.com/dompurify/-/dompurify-3.2.1.tgz#d480972aeb1a59eb8ac47cba95558fbd72a0127b"
Expand Down Expand Up @@ -7660,33 +7648,6 @@ merge2@^1.3.0, merge2@^1.4.1:
resolved "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz"
integrity sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==

mermaid@^11.4.0:
version "11.4.0"
resolved "https://registry.yarnpkg.com/mermaid/-/mermaid-11.4.0.tgz#e510f45700ed4b31e1dc327b3a405ad9f6907ca3"
integrity sha512-mxCfEYvADJqOiHfGpJXLs4/fAjHz448rH0pfY5fAoxiz70rQiDSzUUy4dNET2T08i46IVpjohPd6WWbzmRHiPA==
dependencies:
"@braintree/sanitize-url" "^7.0.1"
"@iconify/utils" "^2.1.32"
"@mermaid-js/parser" "^0.3.0"
"@types/d3" "^7.4.3"
"@types/dompurify" "^3.0.5"
cytoscape "^3.29.2"
cytoscape-cose-bilkent "^4.1.0"
cytoscape-fcose "^2.2.0"
d3 "^7.9.0"
d3-sankey "^0.12.3"
dagre-d3-es "7.0.11"
dayjs "^1.11.10"
dompurify "^3.0.11 <3.1.7"
katex "^0.16.9"
khroma "^2.1.0"
lodash-es "^4.17.21"
marked "^13.0.2"
roughjs "^4.6.6"
stylis "^4.3.1"
ts-dedent "^2.2.0"
uuid "^9.0.1"

mermaid@^11.4.1:
version "11.4.1"
resolved "https://registry.yarnpkg.com/mermaid/-/mermaid-11.4.1.tgz#577fad5c31a01a06d9f793e298d411f1379eecc8"
Expand Down Expand Up @@ -8088,14 +8049,14 @@ ng-packagr@^19.0.1:
rollup "^4.24.0"

"ngx-markdown@file:lib":
version "19.0.0-beta.1"
version "19.0.0"
dependencies:
tslib "^2.8.1"
optionalDependencies:
clipboard "^2.0.11"
emoji-toolkit "^9.0.1"
katex "^0.16.11"
mermaid "^11.4.0"
mermaid "^11.4.1"
prismjs "^1.29.0"

node-addon-api@^6.1.0:
Expand Down

0 comments on commit 6fc2888

Please sign in to comment.