Skip to content

Commit

Permalink
Test mermaid diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
voatsap committed Oct 17, 2023
1 parent 5caa32e commit 36de9ed
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/get-started-cdev-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,30 @@ This guide will walk you through the steps to deploy your first project with Clu
```

``` mermaid
graph TD
ProjectYaml["Project.yaml<br/>- region"] --> StackYaml
StackYaml["Stack.yaml<br/>- bucket_name<br/>- region<br/>- content"] --> StackTemplate
subgraph StackTemplate["StackTemplate: s3-website"]
Bucket[<b>bucket</b><br/>type: tfmodule<br/>inputs:<br/>- bucket_name<br/>- region<br/>- website settings] --> WebPage
WebPage[<b>web-page-object</b><br/>type: tfmodule<br/>inputs:<br/>- bucket (from bucket ID)<br/>- content] --> Outputs
Outputs[<b>outputs</b><br/>type: printer<br/>outputs:<br/>- websiteUrl] --> WebsiteUrlOutput["WebsiteUrl Output"]
end
Bucket --> AWS_S3_Bucket["AWS S3 Bucket"]
WebPage --> AWS_S3_Object["AWS S3 Object (index.html)"]
style ProjectYaml fill:#ffdddd
style StackYaml fill:#ffdddd
style StackTemplate fill:#ddffdd
style Bucket fill:#ddddff
style WebPage fill:#ddddff
style Outputs fill:#ddddff
```

## Prerequisites

Ensure the following are installed and set up:
Expand Down
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@ markdown_extensions:
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
theme:
name: 'material'
custom_dir: docs/theme-overrides
Expand Down

0 comments on commit 36de9ed

Please sign in to comment.