mirror of
https://github.com/go-i2p/go-i2p.github.io.git
synced 2025-07-02 14:02:06 -04:00
Deploy site generated on 17feedfc34
This commit is contained in:
eyedeekay
1
.gitattributes
vendored
Normal file
1
.gitattributes
vendored
Normal file
@ -0,0 +1 @@
|
||||
* text=auto
|
||||
BIN
images/i2plogo.png
Normal file
BIN
images/i2plogo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
166
index.html
Normal file
166
index.html
Normal file
@ -0,0 +1,166 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>go-i2p/go-i2p.github.io</title>
|
||||
<link rel="stylesheet" href="/style.css">
|
||||
</head>
|
||||
<body>
|
||||
<nav class="nav-sidebar">
|
||||
<div class="repo-info">
|
||||
<h2>
|
||||
<a href="index.html">go-i2p/go-i2p.github.io</a>
|
||||
</h2>
|
||||
<div class="repo-meta">
|
||||
📝 7 commits
|
||||
• 📜 MIT License
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<ul class="nav-links">
|
||||
<li><a href="index.html" class="active">Repository Overview</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
<div class="nav-footer">
|
||||
<a href="https://github.com/go-i2p/go-i2p.github.io" target="_blank">View on GitHub</a>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<div class="main-content">
|
||||
<header class="repo-header">
|
||||
<h1>go-i2p/go-i2p.github.io</h1>
|
||||
<div class="repo-description">A wide variety of tools exist which make it easy to use I2P as a network layer in Go applications.</div>
|
||||
|
||||
<div class="repo-stats">
|
||||
|
||||
<div class="repo-stat">
|
||||
<span>📝</span> <span>7 commits</span>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="repo-stat">
|
||||
<span>📅</span> <span>Last updated: May 6, 2025</span>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="repo-stat">
|
||||
<span>📜</span> <span>MIT License</span>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<main>
|
||||
|
||||
<section id="readme" class="repo-section">
|
||||
<h2>README</h2>
|
||||
<div class="readme-content">
|
||||
<h1 id="overview-of-i2p-for-go">Overview of I2P For Go</h1>
|
||||
|
||||
<p>A wide variety of tools exist which make it easy to use I2P as a network layer in Go applications.
|
||||
These tools integrate at various levels and provide different functionality, but virtually anything is possible using I2P and Go.
|
||||
Eventually, this page will serve as a website for <code>go-i2p</code>, but for now it serves to track the state of various ways of using Go to interact with I2P.</p>
|
||||
|
||||
<h2 id="stuff-that-works">Stuff that works:</h2>
|
||||
|
||||
<h3 id="net-conn-and-net-packetconn-interface-implementations"><code>net.Conn</code> and <code>net.PacketConn</code> interface implementations</h3>
|
||||
|
||||
<p>These act as drop-in replacements for <code>net.Conn</code> and <code>net.PacketConn</code> in your code and libraries.
|
||||
When used correctly, they make it easy to adapt Go applications to I2P.
|
||||
All <code>net.Conn</code> and <code>net.PacketConn</code> interface implementations in Go</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/eyedeekay/onramp" target="_blank"><code>onramp</code> an easy-to-use, automatically-configured library for managing I2P connections, implements net.Conn and net.PacketConn, supports Primary sessions</a> - <code>mature, implements SAMv3.3, Streaming and Datagrams</code></li>
|
||||
<li><a href="https://github.com/eyedeekay/goSam" target="_blank"><code>goSam</code> simple and highly configurable net.Conn implementation, implement a complete HTTP/S/CONNECT proxy in ~50 LOC</a> - <code>mature, implements SAMv3.2, Streaming Only</code></li>
|
||||
<li><a href="https://github.com/eyedeekay/sam3" target="_blank"><code>sam3</code> hightly configurable net.Conn, net.PacketConn implementation, supports Primary sessions, exposes all the options and all the sharp edges</a> - <code>mature, implements SAMv3.3, Streaming and Datagrams</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 id="net-addr-interface-implementation"><code>net.Addr</code> interface implementation</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/eyedeekay/i2pkeys" target="_blank"><code>i2pkeys</code>, formerly part of <code>sam3(above)</code>, now a standalone library used by <code>onramp</code>, <code>goSam</code>, and <code>sam3</code> for common ways of handling loading, unloading, and processing I2P keys</a></li>
|
||||
</ul>
|
||||
|
||||
<h3 id="i2pcontrol-rpc-libraries">I2PControl-RPC Libraries</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/eyedeekay/go-i2pcontrol" target="_blank"><code>go-i2pcontrol</code> an implementation of the I2PControl-RPC protocol in Go as a library</a> - <code>mature but does not provide all possible consts(like ratestats)</code></li>
|
||||
<li><a href="https://github.com/eyedeekay/i2p-control" target="_blank"><code>i2p-control</code> CLI application built using/as a demo of <code>go-i2pcontrol</code></a> - <code>mature but may lack features</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 id="proxies-and-application-layer-adapters">Proxies and Application-Layer Adapters</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/eyedeekay/sam-forwarder" target="_blank"><code>sam-forwarder</code> an I2PTunnel-alike which accepts i2pd-style config files</a> - <code>mature enough for a rewrite</code></li>
|
||||
<li><a href="https://github.com/eyedeekay/go-i2p-bt" target="_blank"><code>go-i2p-bt</code> a Bittorrent library configured using <code>onramp</code> which tracks SAMv3 development and has similar features to I2PSnark</a> - <code>not mature</code></li>
|
||||
</ul>
|
||||
|
||||
<h3 id="software">Software</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://i2pgit.org/idk/reseed-tools/" target="_blank"><code>reseed-tools</code> a freestanding implementation of an I2P Reseed server</a> - <code>mature and extensively used/tested</code></li>
|
||||
<li><a href="https://i2pggit.org/idk/railroad" target="_blank"><code>railroad</code> a blog mostly compatible with Ghost style themes with markdown-based editing</a> - <code>not mature</code></li>
|
||||
</ul>
|
||||
|
||||
<h2 id="stuff-in-progress">Stuff in Progress:</h2>
|
||||
|
||||
<h3 id="router-implementations">Router Implementations</h3>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://github.com/go-i2p/go-i2p" target="_blank"><code>go-i2p</code> a pure-Go implementation of the I2P Router <code>WIP</code></a> - <code>WIP does not work yet</code></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<section id="contributors" class="repo-section">
|
||||
<h2>Top Contributors</h2>
|
||||
<div class="contributors-list">
|
||||
|
||||
<div class="contributor-item">
|
||||
<!-- Use first letter as avatar if no image available -->
|
||||
<div class="contributor-avatar">
|
||||
i
|
||||
</div>
|
||||
<div class="contributor-info">
|
||||
<div class="contributor-name">
|
||||
idk
|
||||
</div>
|
||||
<div class="contributor-commits">
|
||||
4 commits
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="contributor-item">
|
||||
<!-- Use first letter as avatar if no image available -->
|
||||
<div class="contributor-avatar">
|
||||
e
|
||||
</div>
|
||||
<div class="contributor-info">
|
||||
<div class="contributor-name">
|
||||
eyedeekay
|
||||
</div>
|
||||
<div class="contributor-commits">
|
||||
3 commits
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<a href="https://github.com/go-i2p/go-i2p.github.io/graphs/contributors" target="_blank">View all contributors on GitHub →</a>
|
||||
</section>
|
||||
|
||||
</main>
|
||||
|
||||
<footer class="page-footer">
|
||||
<p>Generated on 2025-05-06 04:45:18 • <a href="https://github.com/go-i2p/go-i2p.github.io" target="_blank">View on GitHub</a></p>
|
||||
</footer>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
428
style.css
Normal file
428
style.css
Normal file
@ -0,0 +1,428 @@
|
||||
/* Variables */
|
||||
:root {
|
||||
/* Core Colors */
|
||||
--primary-color: #0366d6;
|
||||
--primary-hover: #0255b3;
|
||||
--secondary-color: #4b5563;
|
||||
--background-color: #ffffff;
|
||||
--sidebar-bg: #f8fafc;
|
||||
--border-color: #e2e8f0;
|
||||
--hover-color: #f1f5f9;
|
||||
--text-color: #1a202c;
|
||||
|
||||
/* Code Block Colors - High Contrast */
|
||||
--code-bg: #1e1e1e;
|
||||
--code-text: #d4d4d4;
|
||||
--code-inline-bg: #2d2d2d;
|
||||
--code-border: #404040;
|
||||
--code-comment: #6a9955;
|
||||
--code-keyword: #569cd6;
|
||||
--code-string: #ce9178;
|
||||
--code-number: #b5cea8;
|
||||
|
||||
/* Table Colors - High Contrast */
|
||||
--table-header-bg: #f0f0f0;
|
||||
--table-header-text: #000000;
|
||||
--table-border: #d0d0d0;
|
||||
--table-row-bg: #ffffff;
|
||||
--table-row-alt-bg: #f7f7f7;
|
||||
--table-cell-padding: 12px 16px;
|
||||
|
||||
/* Layout */
|
||||
--sidebar-width: 260px;
|
||||
--content-max-width: 1200px;
|
||||
--radius-sm: 4px;
|
||||
--radius-md: 6px;
|
||||
--radius-lg: 8px;
|
||||
}
|
||||
|
||||
/* Base Styles */
|
||||
* {
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
|
||||
line-height: 1.6;
|
||||
color: var(--text-color);
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
display: flex;
|
||||
min-height: 100vh;
|
||||
background-color: var(--background-color);
|
||||
}
|
||||
|
||||
/* Typography */
|
||||
a {
|
||||
color: var(--primary-color);
|
||||
text-decoration: none;
|
||||
transition: color 0.2s ease;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: var(--primary-hover);
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:focus {
|
||||
outline: 2px solid var(--primary-color);
|
||||
outline-offset: 2px;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
margin-top: 24px;
|
||||
margin-bottom: 16px;
|
||||
font-weight: 600;
|
||||
line-height: 1.25;
|
||||
}
|
||||
|
||||
h1, h2 {
|
||||
padding-bottom: 0.3em;
|
||||
border-bottom: 1px solid var(--border-color);
|
||||
}
|
||||
|
||||
h1 { font-size: 2em; }
|
||||
h2 { font-size: 1.5em; }
|
||||
|
||||
/* Code Elements - Enhanced */
|
||||
pre, code {
|
||||
font-family: 'SF Mono', SFMono-Regular, Consolas, 'Liberation Mono', Menlo, monospace;
|
||||
font-size: 14px;
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: 16px;
|
||||
margin: 16px 0;
|
||||
overflow: auto;
|
||||
background-color: var(--code-bg);
|
||||
color: var(--code-text);
|
||||
border: 1px solid var(--code-border);
|
||||
border-radius: var(--radius-md);
|
||||
box-shadow: inset 0 1px 3px rgba(0, 0, 0, 0.2);
|
||||
max-height: 500px;
|
||||
}
|
||||
|
||||
code {
|
||||
padding: 3px 6px;
|
||||
background-color: var(--code-inline-bg);
|
||||
color: var(--code-text);
|
||||
border-radius: var(--radius-sm);
|
||||
}
|
||||
|
||||
pre code {
|
||||
padding: 0;
|
||||
background: none;
|
||||
border-radius: 0;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
/* Code Block Scroll */
|
||||
pre::-webkit-scrollbar {
|
||||
width: 12px;
|
||||
height: 12px;
|
||||
}
|
||||
|
||||
pre::-webkit-scrollbar-track {
|
||||
background: var(--code-bg);
|
||||
}
|
||||
|
||||
pre::-webkit-scrollbar-thumb {
|
||||
background-color: var(--code-border);
|
||||
border: 3px solid var(--code-bg);
|
||||
border-radius: 6px;
|
||||
}
|
||||
|
||||
/* Syntax Highlighting */
|
||||
.comment { color: var(--code-comment); }
|
||||
.keyword { color: var(--code-keyword); }
|
||||
.string { color: var(--code-string); }
|
||||
.number { color: var(--code-number); }
|
||||
|
||||
/* Tables - Enhanced */
|
||||
table {
|
||||
width: 100%;
|
||||
border-collapse: separate;
|
||||
border-spacing: 0;
|
||||
margin: 24px 0;
|
||||
border: 1px solid var(--table-border);
|
||||
border-radius: var(--radius-lg);
|
||||
overflow: hidden;
|
||||
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
thead {
|
||||
background-color: var(--table-header-bg);
|
||||
}
|
||||
|
||||
th {
|
||||
background-color: var(--table-header-bg);
|
||||
color: var(--table-header-text);
|
||||
font-weight: 600;
|
||||
text-align: left;
|
||||
padding: var(--table-cell-padding);
|
||||
border-bottom: 2px solid var(--table-border);
|
||||
}
|
||||
|
||||
td {
|
||||
padding: var(--table-cell-padding);
|
||||
border-bottom: 1px solid var(--table-border);
|
||||
background-color: var(--table-row-bg);
|
||||
}
|
||||
|
||||
tr:last-child td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
tbody tr:nth-child(even) td {
|
||||
background-color: var(--table-row-alt-bg);
|
||||
}
|
||||
|
||||
th:not(:first-child),
|
||||
td:not(:first-child) {
|
||||
border-left: 1px solid var(--table-border);
|
||||
}
|
||||
|
||||
tbody tr:hover td {
|
||||
background-color: #f0f7ff;
|
||||
}
|
||||
|
||||
/* Media */
|
||||
img {
|
||||
max-width: 100%;
|
||||
height: auto;
|
||||
border-radius: var(--radius-sm);
|
||||
}
|
||||
|
||||
/* Layout */
|
||||
aside.nav-sidebar {
|
||||
width: var(--sidebar-width);
|
||||
background-color: var(--sidebar-bg);
|
||||
border-right: 1px solid var(--border-color);
|
||||
overflow-y: auto;
|
||||
position: sticky;
|
||||
top: 0;
|
||||
height: 100vh;
|
||||
padding: 20px;
|
||||
}
|
||||
|
||||
main.main-content {
|
||||
flex: 1;
|
||||
padding: 40px;
|
||||
max-width: var(--content-max-width);
|
||||
margin: 0 auto;
|
||||
}
|
||||
|
||||
/* Repository Information */
|
||||
.repo-info {
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.repo-info h2 {
|
||||
margin: 0;
|
||||
border: none;
|
||||
font-size: 1.25em;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.repo-meta {
|
||||
font-size: 0.9em;
|
||||
color: var(--secondary-color);
|
||||
}
|
||||
|
||||
/* Navigation */
|
||||
.nav-links {
|
||||
list-style-type: none;
|
||||
padding: 0;
|
||||
margin: 0 0 20px 0;
|
||||
}
|
||||
|
||||
.nav-links li {
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
|
||||
.nav-links a {
|
||||
display: block;
|
||||
padding: 8px 12px;
|
||||
border-radius: var(--radius-md);
|
||||
transition: background-color 0.2s ease;
|
||||
}
|
||||
|
||||
.nav-links a:hover {
|
||||
background-color: var(--hover-color);
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.nav-links a.active {
|
||||
font-weight: 600;
|
||||
background-color: rgba(3, 102, 214, 0.1);
|
||||
color: var(--primary-color);
|
||||
}
|
||||
|
||||
.nav-section-title {
|
||||
font-weight: 600;
|
||||
margin: 16px 0 8px 0;
|
||||
color: var(--secondary-color);
|
||||
}
|
||||
|
||||
.nav-footer {
|
||||
margin-top: 20px;
|
||||
font-size: 0.9em;
|
||||
color: var(--secondary-color);
|
||||
}
|
||||
|
||||
/* Repository Components */
|
||||
.repo-header {
|
||||
margin-bottom: 30px;
|
||||
}
|
||||
|
||||
.repo-stats {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 16px;
|
||||
margin-bottom: 16px;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
.repo-stat {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 8px;
|
||||
padding: 4px 8px;
|
||||
background-color: var(--hover-color);
|
||||
border-radius: var(--radius-sm);
|
||||
}
|
||||
|
||||
/* Contributors Section */
|
||||
.contributors-list {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
gap: 20px;
|
||||
margin-top: 20px;
|
||||
}
|
||||
|
||||
.contributor-item {
|
||||
flex: 1 1 calc(33% - 20px);
|
||||
min-width: 200px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 12px;
|
||||
padding: 16px;
|
||||
border: 1px solid var(--border-color);
|
||||
border-radius: var(--radius-md);
|
||||
background-color: var(--background-color);
|
||||
transition: transform 0.2s ease, box-shadow 0.2s ease;
|
||||
}
|
||||
|
||||
.contributor-item:hover {
|
||||
transform: translateY(-2px);
|
||||
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
.contributor-avatar {
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
border-radius: 50%;
|
||||
background-color: var(--primary-color);
|
||||
color: white;
|
||||
text-align: center;
|
||||
line-height: 40px;
|
||||
font-size: 18px;
|
||||
}
|
||||
|
||||
.contributor-info {
|
||||
flex: 1;
|
||||
}
|
||||
|
||||
.contributor-name {
|
||||
font-weight: 600;
|
||||
color: var(--text-color);
|
||||
}
|
||||
|
||||
.contributor-commits {
|
||||
font-size: 0.9em;
|
||||
color: var(--secondary-color);
|
||||
}
|
||||
|
||||
/* Footer */
|
||||
.page-footer {
|
||||
margin-top: 40px;
|
||||
padding-top: 20px;
|
||||
border-top: 1px solid var(--border-color);
|
||||
color: var(--secondary-color);
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
/* Responsive Design */
|
||||
@media (max-width: 768px) {
|
||||
body {
|
||||
flex-direction: column;
|
||||
}
|
||||
|
||||
.nav-sidebar {
|
||||
width: 100%;
|
||||
height: auto;
|
||||
position: relative;
|
||||
border-right: none;
|
||||
border-bottom: 1px solid var(--border-color);
|
||||
padding: 15px;
|
||||
}
|
||||
|
||||
.main-content {
|
||||
padding: 20px;
|
||||
}
|
||||
|
||||
.contributor-item {
|
||||
flex: 1 1 100%;
|
||||
}
|
||||
|
||||
.repo-stats {
|
||||
flex-direction: column;
|
||||
}
|
||||
|
||||
table {
|
||||
display: block;
|
||||
overflow-x: auto;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
th, td {
|
||||
min-width: 120px;
|
||||
}
|
||||
}
|
||||
|
||||
/* Print Styles */
|
||||
@media print {
|
||||
body {
|
||||
color: #000;
|
||||
background: #fff;
|
||||
}
|
||||
|
||||
.nav-sidebar {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.main-content {
|
||||
max-width: none;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
a {
|
||||
text-decoration: underline;
|
||||
color: #000;
|
||||
}
|
||||
|
||||
pre, code {
|
||||
border: 1px solid #ddd;
|
||||
white-space: pre-wrap;
|
||||
}
|
||||
|
||||
table {
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
th, td {
|
||||
border: 1px solid #000;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user