mirror of
https://github.com/go-micro/go-micro.git
synced 2025-11-23 21:44:41 +02:00
fix links
This commit is contained in:
Asim Aslam
@@ -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
|
||||
|
||||
59
internal/website/_data/navigation.yml
Normal file
59
internal/website/_data/navigation.yml
Normal file
@@ -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/
|
||||
@@ -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 @@
|
||||
</header>
|
||||
<div class="layout">
|
||||
<aside class="sidebar">
|
||||
<h4>Core</h4>
|
||||
<ul>
|
||||
<li><a href="/docs/">Overview</a></li>
|
||||
<li><a href="/docs/getting-started/">Getting Started</a></li>
|
||||
<li><a href="/docs/architecture/">Architecture</a></li>
|
||||
<li><a href="/docs/config/">Configuration</a></li>
|
||||
<li><a href="/docs/observability/">Observability</a></li>
|
||||
</ul>
|
||||
<h4>Interfaces</h4>
|
||||
<ul>
|
||||
<li><a href="/docs/registry/">Registry</a></li>
|
||||
<li><a href="/docs/broker/">Broker</a></li>
|
||||
<li><a href="/docs/transport/">Transport</a></li>
|
||||
<li><a href="/docs/store/">Store</a></li>
|
||||
<li><a href="/docs/plugins/">Plugins</a></li>
|
||||
</ul>
|
||||
<h4>Examples</h4>
|
||||
<ul>
|
||||
<li><a href="/docs/examples/">Learn by Example</a></li>
|
||||
<li><a href="/docs/examples/realworld/">Real-World</a></li>
|
||||
</ul>
|
||||
<h4>Guides</h4>
|
||||
<ul>
|
||||
<li><a href="/docs/guides/comparison/">Comparison</a></li>
|
||||
<li><a href="/docs/guides/migration/">Migration</a></li>
|
||||
</ul>
|
||||
<h4>Project</h4>
|
||||
<ul>
|
||||
<li><a href="/docs/contributing/">Contributing</a></li>
|
||||
<li><a href="/docs/roadmap/">Roadmap</a></li>
|
||||
<li><a href="/docs/architecture/index.html">ADR Index</a></li>
|
||||
</ul>
|
||||
{% assign nav = site.data.navigation %}
|
||||
{% for section in nav %}
|
||||
{% unless section[0] == 'search_order' %}
|
||||
<h4>{{ section[0] | capitalize }}</h4>
|
||||
<ul>
|
||||
{% for item in section[1] %}
|
||||
<li><a href="{{ item.url }}" {% if item.url == page.url %}style="font-weight:600"{% endif %}>{{ item.title }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endunless %}
|
||||
{% endfor %}
|
||||
</aside>
|
||||
<main class="content markdown-body">
|
||||
{% assign crumbs = page.url | split:'/' %}
|
||||
{% assign docs_root = site.baseurl | append: '/' %}
|
||||
{% if page.url != docs_root and page.url contains docs_root %}
|
||||
<nav style="font-size:.75rem; margin-bottom:1rem;">
|
||||
<a href="{{ site.baseurl }}/">Docs</a>
|
||||
{% capture path_acc %}/docs{% endcapture %}
|
||||
{% for c in crumbs %}
|
||||
{% if forloop.index0 > 1 and c != '' %}
|
||||
{% capture path_acc %}{{ path_acc }}/{{ c }}{% endcapture %}
|
||||
› <a href="{{ path_acc }}/">{{ c | replace:'.html','' | replace:'index','' | replace:'realworld','Real-World' | replace:'guides','Guides' | replace:'migration','Migration' | replace:'architecture','Architecture' | replace:'examples','Examples' | replace:'config','Configuration' | replace:'observability','Observability' | capitalize }}</a>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</nav>
|
||||
{% 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 %}
|
||||
<hr style="margin:2.5rem 0;" />
|
||||
<div style="display:flex; justify-content:space-between; font-size:.85rem;">
|
||||
<nav>
|
||||
<a href="{{ site.baseurl }}/">Docs</a>
|
||||
<a href="{{ site.baseurl }}/search/">Search</a>
|
||||
<a href="https://github.com/micro/go-micro" target="_blank" rel="noopener">GitHub</a>
|
||||
<a href="/">Home</a>
|
||||
</nav>
|
||||
<div>
|
||||
{% assign next_index = current_index | plus: 1 %}
|
||||
{% if next_index < order.size %}
|
||||
{% assign next_url = order[next_index] %}
|
||||
<a href="{{ next_url }}">Next →</a>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
</main>
|
||||
</div>
|
||||
<footer>
|
||||
© {{ site.time | date: '%Y' }} Go Micro. Built with Jekyll. <a href="https://github.com/micro/go-micro">GitHub</a>
|
||||
</footer>
|
||||
<script>
|
||||
(function(){
|
||||
const key='gm.dark';
|
||||
function apply(){
|
||||
if(localStorage.getItem(key)==='1'){
|
||||
document.body.classList.add('dark');
|
||||
} else {
|
||||
document.body.classList.remove('dark');
|
||||
}
|
||||
}
|
||||
apply();
|
||||
const btn=document.getElementById('dark-toggle');
|
||||
if(btn){
|
||||
btn.addEventListener('click', function(){
|
||||
localStorage.setItem(key, localStorage.getItem(key)==='1' ? '0' : '1');
|
||||
apply();
|
||||
});
|
||||
}
|
||||
})();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
39
internal/website/docs/search.md
Normal file
39
internal/website/docs/search.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
layout: default
|
||||
---
|
||||
|
||||
# Search Documentation
|
||||
|
||||
Type below to search page titles and content.
|
||||
|
||||
<input id="gm-search" type="text" placeholder="Search docs..." style="width:100%; padding:.6rem .75rem; border:1px solid #d0d7de; border-radius:6px; margin: .5rem 0 1.25rem;" />
|
||||
<div id="gm-results"></div>
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/npm/fuse.js@6.6.2"></script>
|
||||
<script>
|
||||
(function(){
|
||||
const pages = [
|
||||
{% assign docs = site.pages | where_exp:'p','p.url contains '/docs/'' %}
|
||||
{% for p in docs %}
|
||||
{
|
||||
url: '{{ p.url }}',
|
||||
title: {{ p.title | default: p.url | jsonify }},
|
||||
content: {{ p.content | strip_html | replace: '\n',' ' | truncate: 400 | jsonify }}
|
||||
}{% unless forloop.last %},{% endunless %}
|
||||
{% endfor %}
|
||||
];
|
||||
const fuse = new Fuse(pages, { keys: ['title','content'], threshold: 0.4 });
|
||||
const input = document.getElementById('gm-search');
|
||||
const out = document.getElementById('gm-results');
|
||||
input.addEventListener('input', function(){
|
||||
const q = this.value.trim();
|
||||
if(!q){ out.innerHTML=''; return; }
|
||||
const results = fuse.search(q, { limit: 12 });
|
||||
out.innerHTML = '<ul style="list-style:none; padding:0; margin:0;">' +
|
||||
results.map(r => '<li style="margin:.6rem 0;">'+
|
||||
'<a href="'+r.item.url+'" style="font-weight:600">'+r.item.title+'</a><br />'+
|
||||
'<span style="font-size:.75rem; color:#555;">'+(r.item.content.substring(0,160))+'...</span>'+
|
||||
'</li>').join('') + '</ul>';
|
||||
});
|
||||
})();
|
||||
</script>
|
||||
Reference in New Issue
Block a user