Does verbose mode even work, anyways, releasing V1 now
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja> git-svn-id: file:///srv/svn/repo/mai/trunk@64 e410bdd4-646f-c54f-a7ce-fffcc4f439ae
This commit is contained in:
yakumo.izuru
parent
b10a5036d8
commit
ed41833994
1
doc.go
1
doc.go
@ -1,4 +1,5 @@
|
||||
// Package mai is an usable frontend for popular translation engines
|
||||
// Originally based on SimplyTranslate, and took inspiration from the following projects:
|
||||
// Partage, PixivFE, etc.
|
||||
// For more information see mai(1) mai.ini(5)
|
||||
package mai
|
||||
|
||||
1
mai.1
1
mai.1
@ -7,6 +7,7 @@
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl f Ar config-file
|
||||
.Op Fl v
|
||||
.Sh DESCRIPTION
|
||||
This project has been forked from the remains of the
|
||||
rewrite of the SimplyTranslate project, which is currently
|
||||
|
||||
114
static/docs.css
Normal file
114
static/docs.css
Normal file
@ -0,0 +1,114 @@
|
||||
/*
|
||||
* Taken from vnpower
|
||||
*/
|
||||
|
||||
* {
|
||||
box-sizing: border-box; }
|
||||
|
||||
body {
|
||||
top: 0;
|
||||
margin: 0;
|
||||
background-color: #1d1f21;
|
||||
color: white;
|
||||
font-family: "Open Sans", "Roboto", "Noto Sans", "Noto Sans CJK JP", sans-serif;
|
||||
line-height: 1.618;
|
||||
}
|
||||
|
||||
h2.get {
|
||||
color: orange;
|
||||
}
|
||||
|
||||
h2.post {
|
||||
color: green;
|
||||
}
|
||||
|
||||
@media (max-width: 684px) {
|
||||
body {
|
||||
font-size: 1rem; } }
|
||||
|
||||
@media (max-width: 382px) {
|
||||
body {
|
||||
font-size: 1rem; } }
|
||||
|
||||
a {
|
||||
color: #81a2be;
|
||||
text-decoration-color: #81a2be; }
|
||||
|
||||
#header {
|
||||
width: 100%;
|
||||
min-width: 320px;
|
||||
background-color: #282a2e; }
|
||||
|
||||
#header img {
|
||||
width: 280px; }
|
||||
|
||||
#header-content {
|
||||
margin: 0 auto;
|
||||
width: min-content; }
|
||||
|
||||
#nav {
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
background-color: #373b41; }
|
||||
|
||||
#footer {
|
||||
margin-top: 0.5rem;
|
||||
text-align: center; }
|
||||
|
||||
#body {
|
||||
min-height: 75vh;
|
||||
max-width: 800px;
|
||||
margin: 1rem auto;
|
||||
padding: 0 0.6rem; }
|
||||
#body h1,
|
||||
#body h2,
|
||||
#body h3,
|
||||
#body h4,
|
||||
#body h5,
|
||||
#body h6 {
|
||||
line-height: 1.1;
|
||||
font-family: sans-serif;
|
||||
font-weight: 700;
|
||||
margin-top: 1rem;
|
||||
margin-bottom: 1rem;
|
||||
overflow-wrap: break-word;
|
||||
word-wrap: break-word;
|
||||
-ms-word-break: break-all;
|
||||
word-break: break-word; }
|
||||
#body h1 {
|
||||
border-bottom: 1px solid #b5bd68;
|
||||
display: block; }
|
||||
#body p {
|
||||
margin-top: 0px;
|
||||
margin-bottom: 0.5rem; }
|
||||
#body li > p {
|
||||
padding: 0;
|
||||
margin: 0; }
|
||||
#body small,
|
||||
#body sub,
|
||||
#body sup {
|
||||
font-size: 75%; }
|
||||
#body img,
|
||||
#body video {
|
||||
height: auto;
|
||||
max-width: 100%;
|
||||
margin-top: 0.5rem;
|
||||
margin-bottom: 0.5rem;
|
||||
box-shadow: 0px 1px 1px 0px rgba(0, 0, 0, 0.12), 0px 2px 2px 0px rgba(0, 0, 0, 0.12), 0px 4px 4px 0px rgba(0, 0, 0, 0.12), 0px 8px 8px 0px rgba(0, 0, 0, 0.12), 0px 16px 16px 0px rgba(0, 0, 0, 0.12); }
|
||||
#body pre {
|
||||
background-color: #373b41;
|
||||
display: block;
|
||||
padding: 1em;
|
||||
overflow-x: auto;
|
||||
margin-top: 0px;
|
||||
margin-bottom: 0.5rem; }
|
||||
#body code, #body kbd, #body samp {
|
||||
padding: 0 0.5em;
|
||||
background-color: #373b41;
|
||||
white-space: pre-wrap; }
|
||||
#body pre > code {
|
||||
padding: 0;
|
||||
background-color: transparent;
|
||||
white-space: pre;
|
||||
font-size: 1em; }
|
||||
|
||||
56
static/docs/index.html
Normal file
56
static/docs/index.html
Normal file
@ -0,0 +1,56 @@
|
||||
<!DOCTYPE HTML PUBLIC "//W3C DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<link rel="stylesheet" href="/static/docs.css">
|
||||
<meta http-equiv="Content-type" content="text/html; charset=utf-8">
|
||||
<meta name="author" content="Izuru Yakumo">
|
||||
<title>API Documentation | Mai</title>
|
||||
</head>
|
||||
<body id="body">
|
||||
<h1 id="header">Documentation</h1>
|
||||
<br><hr>
|
||||
<h2 class="get">[GET] /api/translate</h2>
|
||||
<h2 class="post">[POST] /api/translate</h2>
|
||||
<h3>Description</h3>
|
||||
<p>Translation endpoint</p>
|
||||
<h3>Arguments</h3>
|
||||
<ul>
|
||||
<li>engine</li>
|
||||
<li>from</li>
|
||||
<li>text</li>
|
||||
<li>to</li>
|
||||
</ul>
|
||||
<h3>Examples</h3>
|
||||
<p><pre><code>GET /api/translate?engine=google&from=auto&to=en&text="sonrisa"</code></pre></p>
|
||||
<hr>
|
||||
<h2 class="get">[GET] /api/source_languages</h2>
|
||||
<h2 class="get">[GET] /api/target_languages</h2>
|
||||
<h3>Description</h3>
|
||||
<p>Get a JSON array of supported source and target languages for a particular engine</p>
|
||||
<h3>Arguments</h3>
|
||||
<ul>
|
||||
<li>engine</li>
|
||||
</ul>
|
||||
<h3>Examples</h3>
|
||||
<p><pre><code>GET /api/source_languages?engine=google</code></pre></p>
|
||||
<p><pre><code>GET /api/target_languages?engine=google</code></pre></p>
|
||||
<hr>
|
||||
<h2 class="get">[GET] /api/tts</h2>
|
||||
<h3>Description</h3>
|
||||
<p>Obtain text-to-speech audio files from an engine, provided said engine supports them</p>
|
||||
<h3>Arguments</h3>
|
||||
<ul>
|
||||
<li>engine</li>
|
||||
<li>lang</li>
|
||||
<li>text</li>
|
||||
</ul>
|
||||
<h3>Examples</h3>
|
||||
<p><pre><code>GET /api/tts?engine=google&lang=en&text="hi"</code></pre></p>
|
||||
<hr>
|
||||
<h2 class="post">[POST] /switchlanguages</h2>
|
||||
<h3>Description</h3>
|
||||
<p>Switch between source and target languages, as long as the source language isn't "auto"</p>
|
||||
<hr>
|
||||
<a href="/">Return to Mai</a>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
x
Reference in New Issue
Block a user