Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_templates/privmx/favicon.ico
Binary file not shown.
173 changes: 173 additions & 0 deletions docs/_templates/privmx/layout/_master.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
{{!include(/^public/.*/)}}
{{!include(favicon.ico)}}
{{!include(logo.svg)}}
<!DOCTYPE html>
<html {{#_lang}}lang="{{_lang}}"{{/_lang}}>
<head>
<meta charset="utf-8">
{{#redirect_url}}
<meta http-equiv="refresh" content="0;URL='{{redirect_url}}'">
{{/redirect_url}}
{{^redirect_url}}
<title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
{{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
{{#description}}<meta name="description" content="{{description}}">{{/description}}
<link rel="icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
<link rel="stylesheet" href="{{_rel}}public/docfx.min.css">
<link rel="stylesheet" href="{{_rel}}public/main.css">
<meta name="docfx:navrel" content="{{_navRel}}">
<meta name="docfx:tocrel" content="{{_tocRel}}">
{{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
{{#_enableSearch}}<meta name="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
{{#_disableNewTab}}<meta name="docfx:disablenewtab" content="true">{{/_disableNewTab}}
{{#_disableTocFilter}}<meta name="docfx:disabletocfilter" content="true">{{/_disableTocFilter}}
{{#docurl}}<meta name="docfx:docurl" content="{{docurl}}">{{/docurl}}
<meta name="loc:inThisArticle" content="{{__global.inThisArticle}}">
<meta name="loc:searchResultsCount" content="{{__global.searchResultsCount}}">
<meta name="loc:searchNoResults" content="{{__global.searchNoResults}}">
<meta name="loc:tocFilter" content="{{__global.tocFilter}}">
<meta name="loc:nextArticle" content="{{__global.nextArticle}}">
<meta name="loc:prevArticle" content="{{__global.prevArticle}}">
<meta name="loc:themeLight" content="{{__global.themeLight}}">
<meta name="loc:themeDark" content="{{__global.themeDark}}">
<meta name="loc:themeAuto" content="{{__global.themeAuto}}">
<meta name="loc:changeTheme" content="{{__global.changeTheme}}">
<meta name="loc:copy" content="{{__global.copy}}">
<meta name="loc:downloadPdf" content="{{__global.downloadPdf}}">

<script type="module" src="./{{_rel}}public/docfx.min.js"></script>

<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>

{{#_googleAnalyticsTagId}}
<script async src="https://www.googletagmanager.com/gtag/js?id={{_googleAnalyticsTagId}}"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() { dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', '{{_googleAnalyticsTagId}}');
</script>
{{/_googleAnalyticsTagId}}
{{/redirect_url}}

<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:ital,wght@0,100..800;1,100..800&family=Manrope:wght@200..800&display=swap" rel="stylesheet">

</head>

{{^redirect_url}}
<body class="tex2jax_ignore" data-layout="{{_layout}}{{layout}}" data-yaml-mime="{{yamlmime}}">
<header class="bg-body border-bottom">
{{^_disableNavbar}}
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<div class="pmx-header">
<a class="pmx-logo" role="button" href="https://docs.privmx.dev">
<div class="pmx-privmx">
PrivMX
<span class="pmx-docs">DOCS</span>
</div>
</a>
</div>
<a class="navbar-brand" href="{{_appLogoUrl}}{{^_appLogoUrl}}{{_rel}}index.html{{/_appLogoUrl}}">
{{_appName}}
</a>
<select name="version" class="pmx-version-switch"><option>{{_docVersion}}</option></select>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
{{#_enableSearch}}
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="{{__global.search}}" autocomplete="off" aria-label="Search">
</form>
{{/_enableSearch}}
</div>
</div>
</div>
</nav>
{{/_disableNavbar}}
</header>

<main class="container-xxl">
{{^_disableToc}}
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
{{/_disableToc}}

<div class="content">
<div class="actionbar">
{{^_disableToc}}
<button class="btn btn-lg border-0 d-md-none"
type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas"
aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
{{/_disableToc}}

{{^_disableBreadcrumb}}
<nav id="breadcrumb"></nav>
{{/_disableBreadcrumb}}
</div>

<article data-uid="{{uid}}">
{{!body}}
</article>

{{^_disableContribution}}
<div class="contribution d-print-none">
{{#sourceurl}}
<a href="{{sourceurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
{{/sourceurl}}
{{^sourceurl}}{{#docurl}}
<a href="{{docurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
{{/docurl}}{{/sourceurl}}
</div>
{{/_disableContribution}}

{{^_disableNextArticle}}
<div class="next-article d-print-none border-top" id="nextArticle"></div>
{{/_disableNextArticle}}

</div>

{{^_disableAffix}}
<div class="affix">
<nav id="affix"></nav>
</div>
{{/_disableAffix}}
</main>

{{#_enableSearch}}
<div class="container-xxl search-results" id="search-results"></div>
{{/_enableSearch}}

<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
{{_appName}} {{_docVersion}}
</div>
</div>
</footer>
<script type="text/javascript" src="{{_rel}}../versions-switch.js" data-pmx-version="{{_docVersion}}"></script>
</body>
{{/redirect_url}}
</html>
151 changes: 151 additions & 0 deletions docs/_templates/privmx/public/main.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
:root,
html[data-bs-theme="light"] {
--pmx-primary: #008F7C;
--pmx-primary-hsl: 172, 100%, 28%;
--pmx-primary-rgb: 0, 143, 124;
--pmx-secondary: #EDEDED;
--pmx-secondary-hsl: 0, 0%, 93%;
--pmx-secondary-rgb: 237, 237, 237;
--pmx-text: #2B4046;
--pmx-text-hsl: 193, 24%, 22%;
--pmx-text-rgb: 43, 64, 70;
--pmx-background: #F5F5F5;
--pmx-background-hsl: 0, 0%, 96%;
--pmx-background-rgb: 245, 245, 245;
--pmx-muted-text: #60696C;
--pmx-muted-text-hsl: 195, 6%, 40%;
--pmx-muted-text-rgb: 96, 105, 108;
--pmx-muted: #D3D7D1;
--pmx-muted-hsl: 100, 7%, 83%;
--pmx-muted-rgb: 211, 215, 209;
--pmx-border: #E0E1E0;
--pmx-border-hsl: 120, 2%, 88%;
--pmx-border-rgb: 224, 225, 224;
--pmx-card: #EFF0EF;
--pmx-card-hsl: 120, 3%, 94%;
--pmx-card-rgb: 239, 240, 239;
--pmx-accent: #E6E6E6;
--pmx-accent-hsl: 0, 0%, 90%;
--pmx-accent-rgb: 230, 230, 230;
--pmx-popover: #FAFAFA;
--pmx-popover-hsl: 0, 0%, 98%;
--pmx-popover-rgb: 250, 250, 250;
--pmx-nav-muted-text: #60696C;
--pmx-nav-muted-text-hsl: 195, 6%, 40%;
--pmx-nav-muted-text-rgb: 96, 105, 108;
--pmx-nav-background: #D8E6E4;
--pmx-nav-background-hsl: 171, 22%, 87%;
--pmx-nav-background-rgb: 216, 230, 228;
}

:root,
html[data-bs-theme="dark"] {
--pmx-primary: #00DB66;
--pmx-primary-hsl: 148, 100%, 43%;
--pmx-primary-rgb: 0, 219, 102;
--pmx-secondary: #152A32;
--pmx-secondary-hsl: 197, 41%, 14%;
--pmx-secondary-rgb: 21, 42, 50;
--pmx-text: #DCDDD9;
--pmx-text-hsl: 75, 6%, 86%;
--pmx-text-rgb: 220, 221, 217;
--pmx-background: #00080F;
--pmx-background-hsl: 208, 100%, 3%;
--pmx-background-rgb: 0, 8, 15;
--pmx-muted-text: #D3D7D1;
--pmx-muted-text-hsl: 100, 7%, 83%;
--pmx-muted-text-rgb: 211, 215, 209;
--pmx-muted: #152A32;
--pmx-muted-hsl: 197, 41%, 14%;
--pmx-muted-rgb: 21, 42, 50;
--pmx-border: #0E202A;
--pmx-border-hsl: 201, 50%, 11%;
--pmx-border-rgb: 14, 32, 42;
--pmx-card: #030E16;
--pmx-card-hsl: 205, 76%, 5%;
--pmx-card-rgb: 3, 14, 22;
--pmx-accent: #2B4046;
--pmx-accent-hsl: 193, 24%, 22%;
--pmx-accent-rgb: 43, 64, 70;
--pmx-popover: #0E202A;
--pmx-popover-hsl: 201, 50%, 11%;
--pmx-popover-rgb: 14, 32, 42;
--pmx-nav-muted-text: #B8B8B8;
--pmx-nav-muted-text-hsl: 0, 0%, 72%;
--pmx-nav-muted-text-rgb: 184, 184, 184;
--pmx-nav-background: #04231F;
--pmx-nav-background-hsl: 172, 79%, 8%;
--pmx-nav-background-rgb: 4, 35, 31;
}

:root {
--bs-font-sans-serif: Manrope, system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", "Noto Sans", "Liberation Sans", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
--bs-font-monospace: 'JetBrains Mono', SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;

--bs-body-bg: var(--pmx-background);
--bs-link-color-rgb: var(--pmx-primary-rgb);
--bs-link-hover-color-rgb: var(--pmx-primary-rgb);
--bs-nav-link-color: var(--pmx-nav-muted-text);

--bs-border-color: var(--pmx-border);
}

.bg-body {
background-color: var(--pmx-card) !important;
/* border-color: var(--pmx-border) !important; */
}

.hljs {
background-color: var(--pmx-card) !important;
border: solid 1px var(--pmx-border) !important;
border-radius: .5rem;
}

.link-body-emphasis {
color: var(--pmx-text) !important;
font-weight: 500;
}

.link-secondary {
color: var(--pmx-nav-muted-text) !important;
}

.link-secondary:hover {
color: var(--pmx-muted-text) !important;
}

.text-secondary {
color: var(--pmx-muted-text) !important;
}


.pmx-header {
padding: 0 0.7em;
font-size: 15px;
}

.pmx-header a {
color: var(--pmx-text);
text-decoration: none;
}

.pmx-header .pmx-docs {
background-color: var(--pmx-muted);
padding: 4px;
border-radius: 4px;
font-size: 12px;
font-family: var(--bs-font-monospace);
color: var(--pmx-muted-text);
margin: 0 0.25rem;
}

.pmx-version-switch {
font-family: var(--font-family-normal);
padding: .5rem;
border: none;
background-color: var(--pmx-muted);
border-radius: 8px;
/* width: 100%; */
text-align: center;
margin: 0.4em 0;
}
8 changes: 8 additions & 0 deletions docs/build-docs-autoversion.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/bin/bash
set -e

SCRIPT_PATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )

cd "$SCRIPT_PATH"

PRIVMX_ENDPOINT_VERSION=$(git describe --tags --always) "$SCRIPT_PATH/build-docs.sh"
14 changes: 14 additions & 0 deletions docs/build-docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/bin/bash

set -e

SCRIPT_PATH=$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )

VERSION=${1:-${PRIVMX_ENDPOINT_VERSION:-""}}

echo "Version: $VERSION"

cd "$SCRIPT_PATH"

docfx metadata
docfx build --metadata _docVersion="$VERSION"
48 changes: 48 additions & 0 deletions docs/docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
"metadata": [
{
"src": [
{
"src": "../PrivMX.Endpoint",
"files": [
"**/*.csproj"
]
}
],
"dest": "api"
}
],
"build": {
"content": [
{
"files": [
"**/*.{md,yml}"
],
"exclude": [
"_site/**"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"output": "_site",
"template": [
"default",
"modern",
"_templates/privmx"
],
"globalMetadata": {
"_appName": "PrivMX Endpoint C#",
"_appTitle": "PrivMX Endpoint C#",
"_enableSearch": true,
"pdf": false,
"_docVersion": ""
}
}
}
Loading