docs: Update likec4-view shortcode documentation with title parameter
- Add title parameter documentation to all relevant README files - Update DOCUMENTOR-GUIDE.md with title parameter example - Enhance quick-reference.md with complete parameter list - Update INTEGRATION.md with recommended shortcode usage - Simplify highlevelarch.md by using shortcode with title parameter
This commit is contained in:
parent
dc2bb1d60d
commit
97cd265063
5 changed files with 38 additions and 48 deletions
|
|
@ -66,6 +66,17 @@ In your Markdown files:
|
|||
{{< likec4-view view="overview" project="documentation-platform" >}}
|
||||
```
|
||||
|
||||
Optional parameters:
|
||||
- `view` (required) - The view ID from your LikeC4 model
|
||||
- `project` (optional, default: "architecture") - The LikeC4 project name
|
||||
- `title` (optional, default: "Architecture View: {view}") - Custom header text
|
||||
|
||||
Example with custom title:
|
||||
|
||||
```markdown
|
||||
{{< likec4-view view="overview" project="documentation-platform" title="Complete Documentation Platform" >}}
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
- `likec4.config.json` - Project configuration
|
||||
|
|
|
|||
|
|
@ -46,11 +46,26 @@ This creates `static/js/likec4-webcomponent.js` which contains all your architec
|
|||
|
||||
## Using in Hugo Content
|
||||
|
||||
Add interactive diagrams to any Markdown page:
|
||||
### Using the Shortcode (Recommended)
|
||||
|
||||
The simplest way to embed diagrams:
|
||||
|
||||
```markdown
|
||||
## Architecture Overview
|
||||
|
||||
{{< likec4-view view="otc-faas" project="architecture" title="OTC FaaS Deployment Architecture" >}}
|
||||
```
|
||||
|
||||
**Parameters:**
|
||||
- `view` (required) - The view ID from your LikeC4 model
|
||||
- `project` (optional, default: "architecture") - The LikeC4 project name
|
||||
- `title` (optional, default: "Architecture View: {view}") - Custom header text
|
||||
|
||||
### Manual HTML (Alternative)
|
||||
|
||||
If you need more control:
|
||||
|
||||
```markdown
|
||||
<div class="likec4-container">
|
||||
<div class="likec4-header">
|
||||
System Architecture - High Level View
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue