Skip to content

Commit

Permalink
Merge pull request #69 from fsegurai/development
Browse files Browse the repository at this point in the history
Development (06/11/2024 - 13:00)
  • Loading branch information
fsegurai authored Nov 6, 2024
2 parents 71a193b + 994fcf6 commit b17a6e6
Show file tree
Hide file tree
Showing 8 changed files with 429 additions and 124 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ on:
workflow_dispatch:
inputs: { }
workflow_call:
workflow_run:
workflows: [ "Build PR" ]
types: [ completed ]

jobs:
test:
Expand Down
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
<div style="text-align: center;">
<p align="center">
<img alt="@fsegurai/ngx-markdown Logo" src="https://raw.githubusercontent.com/fsegurai/ngx-markdown/main/demo/public/ngx-markdown.png">
</p>

![@fsegurai/ngx-markdown Logo](https://raw.githubusercontent.com/fsegurai/ngx-markdown/main/demo/public/ngx-markdown.png)
</div>

<div style="text-align: center;">

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/fsegurai/ngx-markdown/npm-publish-setup.yml)
![GitHub Release](https://img.shields.io/github/v/release/fsegurai/ngx-markdown)
<p align="center">
<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/fsegurai/ngx-markdown/release-library.yml">
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/fsegurai/ngx-markdown">
<br>
![GitHub contributors](https://img.shields.io/github/contributors/fsegurai/ngx-markdown)
![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/fsegurai/ngx-markdown)
[![GitHub License](https://img.shields.io/github/license/fsegurai/ngx-markdown)](https://opensource.org/licenses/MIT)
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/fsegurai/ngx-markdown">
<img alt="Libraries.io dependency status for GitHub repo" src="https://img.shields.io/librariesio/github/fsegurai/ngx-markdown">
<a href="https://opensource.org/licenses/MIT">
<img alt="GitHub License" src="https://img.shields.io/github/license/fsegurai/ngx-markdown">
</a>
<br>
![Stars](https://img.shields.io/github/stars/fsegurai/ngx-markdown?style=square&labelColor=343b41)
![Forks](https://img.shields.io/github/forks/fsegurai/ngx-markdown?style=square&labelColor=343b41)
![NPM Downloads](https://img.shields.io/npm/dt/@fsegurai/ngx-markdown)
</div>
<img alt="Stars" src="https://img.shields.io/github/stars/fsegurai/ngx-markdown?style=square&labelColor=343b41"/>
<img alt="Forks" src="https://img.shields.io/github/forks/fsegurai/ngx-markdown?style=square&labelColor=343b41"/>
<a href="https://www.npmjs.com/package/@fsegurai/ngx-markdown">
<img alt="NPM Downloads" src="https://img.shields.io/npm/dt/@fsegurai/ngx-markdown">
</a>
</p>

**This is just a side project to provide additional features that fulfill my needs.**

Expand Down Expand Up @@ -321,7 +323,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.3.0 --save
npm install mermaid@^11.4.0 --save
```

To activate [Mermaid](https://mermaid-js.github.io/) diagramming and charting tool you will need to include...
Expand Down Expand Up @@ -969,7 +971,7 @@ A demo is available @ [https://fsegurai.github.io/ngx-markdown](https://fsegurai

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

It is recommended to use `yarn` as the package manager to handle the large number of dependencies as it is faster than `npm` and it will mostly not cause any issues.
> It is recommended to use `yarn` as the package manager to handle the large number of dependencies as it is faster than `npm` and it will mostly not cause any issues.
```bash
git clone https://github.com/fsegurai/ngx-markdown.git
Expand Down
2 changes: 1 addition & 1 deletion demo/src/app/cheat-sheet/remote/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There are several ways to create links.

[I'm a reference-style link][Arbitrary case-insensitive reference text]

[I'm a relative reference to a repository file](../blob/master/LICENSE)
[I'm a relative reference to a repository file](favicon.ico)

[You can use numbers for reference-style link definitions][1]

Expand Down
6 changes: 3 additions & 3 deletions lib/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@fsegurai/ngx-markdown",
"version": "18.1.0-beta.1",
"description": "Angular library that uses marked to parse markdown to html combined with Prism.js for synthax highlights",
"version": "18.1.0-beta.2",
"description": "Angular library that uses marked to parse markdown to html combined with Prism.js for syntax highlights",
"homepage": "https://github.com/fsegurai/ngx-markdown",
"license": "MIT",
"author": {
Expand Down Expand Up @@ -41,7 +41,7 @@
"clipboard": "^2.0.11",
"emoji-toolkit": "^9.0.1",
"katex": "^0.16.11",
"mermaid": "^11.3.0",
"mermaid": "^11.4.0",
"prismjs": "^1.29.0"
},
"sideEffects": false
Expand Down
3 changes: 2 additions & 1 deletion lib/src/markdown.service.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,8 @@ describe('MarkdownService', () => {

const blockquote = ({ text }: MarkedToken.Blockquote) => {
const parsedText = markdownService.parseInline(text); // Parse inline Markdown text to HTML
return `<mock-blockquote>${String(parsedText)}</mock-blockquote>`;
const safeParsedText = typeof parsedText === 'string' ? parsedText : JSON.stringify(parsedText);
return `<mock-blockquote>${safeParsedText}</mock-blockquote>`;
};

markdownService.renderer.blockquote = blockquote;
Expand Down
2 changes: 2 additions & 0 deletions lib/src/mermaid-options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,8 @@ export namespace MermaidAPI {

packet?: any; // [todo]

kanban?: any; // [todo]

architecture?: any; // [todo]
}
}
24 changes: 11 additions & 13 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@fsegurai/ngx-markdown",
"version": "18.1.0-beta.1",
"version": "18.1.0-beta.2",
"description": "Angular library that uses marked to parse markdown to html combined with Prism.js for syntax highlights",
"homepage": "https://github.com/fsegurai/ngx-markdown",
"license": "MIT",
Expand Down Expand Up @@ -43,9 +43,7 @@
"test:ci_cd": "ng test --no-watch --no-progress --browsers=ChromeHeadless",
"gh-pages:build": "yarn build:demo --aot --base-href=./",
"gh-pages:copy404": "cpy ./dist/demo/browser/index.html . --rename=404.html",
"gh-pages:postBuild": "cpy ./dist/demo/3rdpartylicenses.txt ./dist/demo/browser --flat",
"publish:lib": "npm publish ./dist/lib",
"publish:beta": "npm publish ./dist/lib --tag beta"
"gh-pages:postBuild": "cpy ./dist/demo/3rdpartylicenses.txt ./dist/demo/browser --flat"
},
"dependencies": {
"@angular/animations": "^18.0.0",
Expand All @@ -66,11 +64,11 @@
"katex": "0.16.11",
"marked": "14.1.3",
"marked-gfm-heading-id": "^4.1.0",
"mermaid": "^11.3.0",
"mermaid": "^11.4.0",
"ngx-markdown": "file:lib",
"prismjs": "^1.29.0",
"rxjs": "~7.8.1",
"tslib": "^2.8.0",
"tslib": "^2.8.1",
"zone.js": "~0.14.10"
},
"devDependencies": {
Expand All @@ -85,16 +83,16 @@
"@angular/cli": "~18.0.1",
"@angular/compiler-cli": "^18.0.0",
"@angular/language-service": "^18.0.0",
"@eslint/js": "^9.13.0",
"@eslint/js": "^9.14.0",
"@types/jasmine": "~5.1.4",
"@typescript-eslint/eslint-plugin": "^8.11.0",
"@typescript-eslint/parser": "^8.11.0",
"@typescript-eslint/types": "8.11.0",
"@typescript-eslint/utils": "^8.11.0",
"@typescript-eslint/eslint-plugin": "^8.13.0",
"@typescript-eslint/parser": "^8.13.0",
"@typescript-eslint/types": "8.13.0",
"@typescript-eslint/utils": "^8.13.0",
"angular-eslint": "^18.4.0",
"coveralls": "^3.1.1",
"cpy-cli": "^5.0.0",
"eslint": "^9.13.0",
"eslint": "^9.14.0",
"eslint-import-resolver-typescript": "~3.6.3",
"eslint-plugin-import": "~2.31.0",
"eslint-plugin-jsdoc": "~50.4.3",
Expand All @@ -110,6 +108,6 @@
"ng-packagr": "^18.0.0",
"rimraf": "^6.0.1",
"typescript": "~5.5.4",
"typescript-eslint": "^8.11.0"
"typescript-eslint": "^8.13.0"
}
}
Loading

0 comments on commit b17a6e6

Please sign in to comment.