Skip to content

Commit 61ff6cc

Browse files
committed
feat(docs): enable callouts and GitHub edit link
- Add callout types: note, warning, important, tip - Add "Edit this page on GitHub" link in footer - Encourages contributions and highlights important info
1 parent 1af6882 commit 61ff6cc

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/_config.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ plugins:
1414
aux_links:
1515
GitHub: https://github.com/vnykmshr/lobster
1616

17+
# Edit on GitHub link
18+
gh_edit_link: true
19+
gh_edit_link_text: "Edit this page on GitHub"
20+
gh_edit_repository: https://github.com/vnykmshr/lobster
21+
gh_edit_branch: main
22+
gh_edit_source: docs
23+
1724
# Footer
1825
footer_content: "Copyright © 2026 Lobster. MIT License."
1926

@@ -42,6 +49,21 @@ mermaid:
4249
# Heading anchor links
4350
heading_anchors: true
4451

52+
# Callouts
53+
callouts:
54+
note:
55+
title: Note
56+
color: blue
57+
warning:
58+
title: Warning
59+
color: red
60+
important:
61+
title: Important
62+
color: yellow
63+
tip:
64+
title: Tip
65+
color: green
66+
4567
# External navigation links open in new tab
4668
nav_external_links_new_tab: true
4769

0 commit comments

Comments
 (0)