diff --git a/internal/website/_config.yml b/internal/website/_config.yml index 0b05d862..60be4e1a 100644 --- a/internal/website/_config.yml +++ b/internal/website/_config.yml @@ -1,7 +1,7 @@ title: Docs description: "A Go microservices framework" -baseurl: "" # the subpath of your site, e.g. /blog -url: "" # the base hostname & protocol for your site, e.g. http://example.com +baseurl: "" # served at root; docs under /docs/ paths +url: "https://go-micro.dev" # domain host # Enable syntax highlighting diff --git a/internal/website/_data/navigation.yml b/internal/website/_data/navigation.yml new file mode 100644 index 00000000..2bdcb3a1 --- /dev/null +++ b/internal/website/_data/navigation.yml @@ -0,0 +1,59 @@ +core: + - title: Overview + url: /docs/ + - title: Getting Started + url: /docs/getting-started/ + - title: Architecture + url: /docs/architecture/ + - title: Configuration + url: /docs/config/ + - title: Observability + url: /docs/observability/ +interfaces: + - title: Registry + url: /docs/registry/ + - title: Broker + url: /docs/broker/ + - title: Transport + url: /docs/transport/ + - title: Store + url: /docs/store/ + - title: Plugins + url: /docs/plugins/ +examples: + - title: Learn by Example + url: /docs/examples/ + - title: Real-World Examples + url: /docs/examples/realworld/ +guides: + - title: Comparison + url: /docs/guides/comparison/ + - title: Migration Guides + url: /docs/guides/migration/ +project: + - title: ADR Index + url: /docs/architecture/index.html + - title: Contributing + url: /docs/contributing/ + - title: Roadmap + url: /docs/roadmap/ + - title: Server (optional) + url: /docs/server/ +search_order: + - /docs/getting-started/ + - /docs/architecture/ + - /docs/config/ + - /docs/observability/ + - /docs/registry/ + - /docs/broker/ + - /docs/transport/ + - /docs/store/ + - /docs/plugins/ + - /docs/examples/ + - /docs/examples/realworld/ + - /docs/guides/comparison/ + - /docs/guides/migration/ + - /docs/architecture/index.html + - /docs/contributing/ + - /docs/roadmap/ + - /docs/server/ \ No newline at end of file diff --git a/internal/website/_layouts/default.html b/internal/website/_layouts/default.html index ef7f416f..e90eca03 100644 --- a/internal/website/_layouts/default.html +++ b/internal/website/_layouts/default.html @@ -15,6 +15,16 @@ a { color:#0366d6; text-decoration:none; } a:hover { text-decoration:underline; } header { display:flex; align-items:center; justify-content:space-between; padding:.75rem 1.5rem; background:#fff; border-bottom:1px solid var(--border); position:sticky; top:0; z-index:20; } + .right-tools { display:flex; align-items:center; gap:.75rem; } + .search-inline { position:relative; } + .search-inline input { padding:.4rem .6rem; border:1px solid #d0d7de; border-radius:4px; font-size:.85rem; width:160px; } + .search-inline input:focus { outline:none; border-color:#0366d6; } + .dark-toggle { cursor:pointer; background:#f6f8fa; border:1px solid #d0d7de; padding:.35rem .6rem; border-radius:4px; font-size:.75rem; } + .dark body, body.dark { --bg:#0d1117; --border:#30363d; color:#e6edf3; background:#0d1117; } + body.dark header, body.dark .sidebar, body.dark .content, body.dark footer { background:#0d1117; } + body.dark a { color:#58a6ff; } + body.dark pre { background:#161b22; border-color:#30363d; } + body.dark .sidebar a:hover { background:#161b22; } .logo-link { display:flex; align-items:center; gap:.5rem; font-weight:600; color:#222; } .logo-link img { height:36px; } header nav a { margin-left:1rem; font-weight:500; } @@ -58,45 +68,83 @@
+ {% assign crumbs = page.url | split:'/' %} + {% assign docs_root = site.baseurl | append: '/' %} + {% if page.url != docs_root and page.url contains docs_root %} + + {% endif %} {{ content }} + {% assign order = site.data.navigation.search_order %} + {% if page.url %} + {% assign current_index = -1 %} + {% for u in order %} + {% if u == page.url %}{% assign current_index = forloop.index0 %}{% endif %} + {% endfor %} + {% if current_index != -1 %} +
+
+ +
+ {% assign next_index = current_index | plus: 1 %} + {% if next_index < order.size %} + {% assign next_url = order[next_index] %} + Next → + {% endif %} +
+
+ {% endif %} + {% endif %}
+ diff --git a/internal/website/docs/search.md b/internal/website/docs/search.md new file mode 100644 index 00000000..705a446b --- /dev/null +++ b/internal/website/docs/search.md @@ -0,0 +1,39 @@ +--- +layout: default +--- + +# Search Documentation + +Type below to search page titles and content. + + +
+ + +