Skip to content

Commit 9ecd3cd

Browse files
rajnavakoticlaude
andauthored
docs: switch to Just the Docs theme with sidebar navigation (#61)
Replaces minimal theme with just-the-docs: sidebar nav, search, dark mode, table of contents, parent/child page hierarchy. 3 sections: Guides (5 pages), Concepts (4 pages), Reference (6 pages). Co-authored-by: Claude <noreply@anthropic.com>
1 parent 3f5f7c4 commit 9ecd3cd

20 files changed

Lines changed: 316 additions & 187 deletions

docs/pages/_config.yml

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,44 @@
11
title: Architecture Blocks
22
description: Versioned draw.io shape library for ArchiMate architecture blocks
3-
remote_theme: pages-themes/minimal@v0.2.0
3+
remote_theme: just-the-docs/just-the-docs
4+
5+
color_scheme: dark
6+
7+
search_enabled: true
8+
search:
9+
heading_level: 3
10+
previews: 3
11+
focus_shortcut_key: "k"
12+
13+
nav_enabled: true
14+
15+
aux_links:
16+
GitHub:
17+
- https://github.com/ea-toolkit/architecture-blocks
18+
npm:
19+
- https://www.npmjs.com/package/@ea-toolkit/architecture-blocks
20+
21+
aux_links_new_tab: true
22+
23+
footer_content: "Architecture Blocks &mdash; MIT License &mdash; <a href=\"https://github.com/ea-toolkit/architecture-blocks\">ea-toolkit/architecture-blocks</a>"
24+
25+
gh_edit_link: true
26+
gh_edit_link_text: "Edit this page on GitHub"
27+
gh_edit_repository: "https://github.com/ea-toolkit/architecture-blocks"
28+
gh_edit_branch: "master"
29+
gh_edit_source: "docs/pages"
30+
gh_edit_view_mode: "edit"
31+
432
plugins:
533
- jekyll-remote-theme
34+
35+
callouts:
36+
warning:
37+
title: Warning
38+
color: yellow
39+
note:
40+
title: Note
41+
color: blue
42+
tip:
43+
title: Tip
44+
color: green

docs/pages/concepts/how-it-works.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
---
2-
layout: default
32
title: How It Works
3+
layout: default
4+
parent: Concepts
5+
nav_order: 1
46
---
57

68
# How It Works
9+
{: .no_toc }
710

811
The complete data flow from YAML definition to upgraded diagram.
12+
{: .fs-6 .fw-300 }
13+
14+
## Table of contents
15+
{: .no_toc .text-delta }
16+
17+
1. TOC
18+
{:toc}
19+
20+
---
921

1022
## The big picture
1123

docs/pages/concepts/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Concepts
3+
layout: default
4+
nav_order: 3
5+
has_children: true
6+
---
7+
8+
# Concepts
9+
10+
How Architecture Blocks works under the hood — the data flow, identity model, properties system, and YAML schema.

docs/pages/concepts/shape-identity.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
---
2-
layout: default
32
title: Shape Identity
3+
layout: default
4+
parent: Concepts
5+
nav_order: 2
46
---
57

68
# Shape Identity
9+
{: .no_toc }
710

811
How shapes are identified, versioned, and tracked across diagrams.
12+
{: .fs-6 .fw-300 }
13+
14+
## Table of contents
15+
{: .no_toc .text-delta }
16+
17+
1. TOC
18+
{:toc}
19+
20+
---
921

1022
## data-block-id
1123

docs/pages/concepts/shape-properties.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
---
2-
layout: default
32
title: Shape Properties
3+
layout: default
4+
parent: Concepts
5+
nav_order: 3
46
---
57

68
# Shape Properties
9+
{: .no_toc }
710

811
Custom metadata that gives shapes context beyond visual appearance.
12+
{: .fs-6 .fw-300 }
13+
14+
## Table of contents
15+
{: .no_toc .text-delta }
16+
17+
1. TOC
18+
{:toc}
19+
20+
---
921

1022
## Why properties matter
1123

docs/pages/concepts/yaml-schema.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
---
2-
layout: default
32
title: YAML Schema
3+
layout: default
4+
parent: Concepts
5+
nav_order: 4
46
---
57

68
# YAML Schema
9+
{: .no_toc }
710

811
The shape definition format explained field by field.
12+
{: .fs-6 .fw-300 }
13+
14+
## Table of contents
15+
{: .no_toc .text-delta }
16+
17+
1. TOC
18+
{:toc}
19+
20+
---
921

1022
## File structure
1123

docs/pages/guides/enterprise.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
---
2+
title: Enterprise Adoption
23
layout: default
3-
title: Enterprise Adoption Guide
4+
parent: Guides
5+
nav_order: 4
46
---
57

6-
# Enterprise Adoption Guide
8+
# Enterprise Adoption
9+
{: .no_toc }
710

811
How to evaluate, pilot, and roll out architecture-blocks across your organization.
12+
{: .fs-6 .fw-300 }
13+
14+
## Table of contents
15+
{: .no_toc .text-delta }
16+
17+
1. TOC
18+
{:toc}
19+
20+
---
921

1022
## Phased rollout
1123

docs/pages/guides/extensions.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
---
2-
layout: default
32
title: Custom Extensions
3+
layout: default
4+
parent: Guides
5+
nav_order: 5
46
---
57

68
# Custom Extensions
9+
{: .no_toc }
710

811
Add org-specific shapes without forking the library.
12+
{: .fs-6 .fw-300 }
13+
14+
## Table of contents
15+
{: .no_toc .text-delta }
16+
17+
1. TOC
18+
{:toc}
19+
20+
---
921

1022
## Why extensions?
1123

docs/pages/guides/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Guides
3+
layout: default
4+
nav_order: 2
5+
has_children: true
6+
---
7+
8+
# Guides
9+
10+
Step-by-step guides for getting started, managing shapes, and rolling out across your organization.

docs/pages/guides/installation.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
---
2-
layout: default
32
title: Installation
3+
layout: default
4+
parent: Guides
5+
nav_order: 1
46
---
57

68
# Installation
9+
{: .no_toc }
10+
11+
## Table of contents
12+
{: .no_toc .text-delta }
13+
14+
1. TOC
15+
{:toc}
16+
17+
---
718

819
## Requirements
920

@@ -28,18 +39,18 @@ npm install --save-dev @ea-toolkit/architecture-blocks
2839
### Full library (all 60 shapes)
2940

3041
1. Open draw.io
31-
2. File > Open Library from > Device
32-
3. Navigate to your project's `node_modules/@ea-toolkit/architecture-blocks/libraries/`
33-
4. Select `architecture-blocks.xml`
42+
2. **File > Open Library from > Device**
43+
3. Navigate to `node_modules/@ea-toolkit/architecture-blocks/libraries/`
44+
4. Select **`architecture-blocks.xml`**
3445

35-
The shapes appear in the sidebar under "Architecture Blocks".
46+
The shapes appear in the sidebar panel, ready to drag onto your canvas.
3647

3748
### Per-layer libraries
3849

39-
If you only work with specific ArchiMate layers, import just the layers you need:
50+
If you only work with specific ArchiMate layers, import just what you need:
4051

4152
| File | Shapes |
42-
|------|--------|
53+
|:-----|:-------|
4354
| `architecture-blocks-application.xml` | 9 application shapes |
4455
| `architecture-blocks-business.xml` | 13 business shapes |
4556
| `architecture-blocks-technology.xml` | 13 technology shapes |
@@ -54,11 +65,9 @@ If you only work with specific ArchiMate layers, import just the layers you need
5465
For teams who want the library loaded automatically:
5566

5667
1. Copy `plugin/architecture-blocks-plugin.js` to a shared location
57-
2. In draw.io: Extras > Plugins > Add > select the plugin file
68+
2. In draw.io: **Extras > Plugins > Add** > select the file
5869
3. Restart draw.io
5970

60-
The plugin auto-loads the library on startup.
61-
6271
## Verify installation
6372

6473
```bash
@@ -75,7 +84,5 @@ npx architecture-blocks version
7584
├── dist/ # CLI + library JavaScript
7685
├── libraries/ # Generated draw.io XML files (importable)
7786
├── shapes/ # YAML source definitions
78-
└── schemas/ # JSON Schema for shape YAML
87+
└── schemas/ # JSON Schema for shape YAML validation
7988
```
80-
81-
[Next: Quick Start >](quick-start.html)

0 commit comments

Comments
 (0)