header.json Reference #
File: content/header.json
Most common edits #
- Add/remove top nav links in
links - Reorder nav links by moving objects up/down
- Link internal docs pages or external URLs
Top-level keys #
| Key | Type | Required | Description |
|---|---|---|---|
links | array | Yes | Ordered list of top-navigation link objects. |
links[] object keys #
| Key path | Type | Required | Description |
|---|---|---|---|
links[].title | string | Yes | Text displayed in header nav. |
links[].path | string | Yes | URL/path target for the link. |
Current example #
json
{"links": [{ "title": "Home", "path": "/" },{ "title": "Introduction", "path": "/guides/introduction" },{ "title": "Quickstart", "path": "/guides/quickstart" },{ "title": "Architecture", "path": "/guides/codebase-architecture" },{ "title": "Components", "path": "/guides/components/index" },{ "title": "JSON Reference", "path": "/guides/json-reference/index" }]}
External link example #
json
{"title": "GitHub","path": "https://github.com/OmgRod/MiniWiki"}