Skip to content

Commit

Permalink
Merge pull request #16 from qazsato/update_readme_graph
Browse files Browse the repository at this point in the history
update readme graph
  • Loading branch information
qazsato authored Nov 25, 2024
2 parents db723a9 + d899db7 commit e6d9749
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 18 deletions.
16 changes: 1 addition & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,7 @@ This makes it easy to:

This portability makes `openapi-generate-html` ideal for situations where reliable, standalone documentation is required.

```mermaid
---
title: Using openapi-generate-html
---
flowchart LR
subgraph After
A1["`.html<br> **All-In-One File!** `"]
end
subgraph Before
B1[.html] -.-> B2@{ shape: procs, label: ".json"}
B1[.html] -.-> B3@{ shape: procs, label: ".js"}
B1[.html] -.-> B4@{ shape: procs, label: ".css"}
end
Before ---> After
```
![Using openapi-generate-html](docs/mermaid.png)

## How to use

Expand Down
15 changes: 15 additions & 0 deletions docs/mermaid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```mermaid
---
title: Using openapi-generate-html
---
flowchart LR
subgraph After
A1["`.html<br> **All-In-One file!** `"]
end
subgraph Before
B1[.html] -.-> B2@{ shape: procs, label: ".json"}
B1[.html] -.-> B3@{ shape: procs, label: ".js"}
B1[.html] -.-> B4@{ shape: procs, label: ".css"}
end
Before ---> After
```
Binary file added docs/mermaid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "openapi-generate-html",
"version": "0.4.0",
"version": "0.4.1",
"description": "Generate standalone HTML from OpenAPI Specification",
"type": "module",
"bin": {
Expand Down

0 comments on commit e6d9749

Please sign in to comment.