Skip to content

Commit

Permalink
doc: add website
Browse files Browse the repository at this point in the history
  • Loading branch information
Crissium committed Oct 29, 2023
1 parent 7768603 commit ee81a00
Show file tree
Hide file tree
Showing 8 changed files with 182 additions and 0 deletions.
82 changes: 82 additions & 0 deletions docs/css/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
/* Basic styling for the body */
body {
background-color: #f0f0f0;
color: #333;
margin: 0;
padding: 0;
}

/* Style the navigation bar */
nav {
background-color: #333;
color: #fff;
padding: 10px;
}

nav ul {
list-style: none;
text-align: center;
}

nav li {
display: inline;
margin-right: 20px;
}

nav a {
text-decoration: none;
color: #fff;
font-weight: bold;
}

/* Style the article content */
article {
max-width: 800px;
margin: 20px auto;
padding: 20px;
background-color: #fff;
box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
}

h1 {
font-size: 24px;
margin-bottom: 10px;
}

h2 {
font-size: 18px;
margin-top: 20px;
margin-bottom: 10px;
}

p {
margin-bottom: 10px;
}

ul {
list-style: disc;
margin-left: 20px;
}

li {
margin-bottom: 5px;
}

/* Style the screenshots */
.screenshot {
display: flex;
flex-wrap: wrap;
gap: 10px;
}

.screenshot img {
max-width: 100%;
height: auto;
}

/* Responsive styles for smaller screens */
@media (max-width: 600px) {
article {
padding: 10px;
}
}
Binary file added docs/img/dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/favicon.ico
Binary file not shown.
Binary file added docs/img/light1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/light2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 63 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>SilverDict</title>
<meta charset="utf-8">
<link rel="stylesheet" href="css/style.css">
<link rel="icon" href="img/favicon.ico" type="image/x-icon">
</head>

<body>
<nav>
<ul>
<li>
<a href="installation.html">Installation</a>
</li>
<li>
<a href="https://github.com/Crissium/SilverDict/wiki">Guides</a>
</li>
<li>
<a href="https://github.com/Crissium/SilverDict">SilverDict on GitHub</a>
</li>
<li>
<a href="https://github.com/Crissium/SilverDict-mobile">SilverDict-mobile on GitHub</a>
</li>
</ul>
</nav>
<article>
<h1>
Welcome to SilverDict!
</h1>
<p>
SilverDict is a free and open source dictionary lookup program that is cross-platform and follows the client/server model. The server side is written in Python with Flask and could be deployed to Linux, Mac OS, Windows, Android (via Termux) and iOS (via a-Shell). It has currently two clients: a React web app that has both desktop and mobile interfaces, and an Android app.
</p>
<h2>
Screenshots
</h2>
<div class="screenshot">
<img src="img/light1.png" alt="Screenshot 1">
<img src="img/light2.png" alt="Screenshot 2">
<img src="img/dark.png" alt="Screenshot 3">
<img src="img/mobile.png" alt="Screenshot 4">
</div>
<p>The dark theme is rendered with the Dark Reader extension.</p>
<h2>
Features
</h2>
<ul>
<li>
Supports DSL, StarDict and MDict
</li>
<li>
Deployable even on mobile devices
</li>
<li>
One home server for all your devices
</li>
<li>
Just works, as expected
</li>
</ul>
</article>
</body>
</html>
37 changes: 37 additions & 0 deletions docs/installation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!DOCTYPE html>
<html lang="en">

<head>
<title>SilverDict Installation</title>
<meta charset="utf-8">
<link rel="stylesheet" href="css/style.css">
<link rel="icon" href="img/favicon.ico" type="image/x-icon">
</head>

<body>
<nav>
<ul>
<li>
<a href="index.html">Home</a>
</li>
<li>
<a href="https://github.com/Crissium/SilverDict/wiki">Guides</a>
</li>
<li>
<a href="https://github.com/Crissium/SilverDict">SilverDict on GitHub</a>
</li>
<li>
<a href="https://github.com/Crissium/SilverDict-mobile">SilverDict-mobile on GitHub</a>
</li>
</ul>
</nav>
<article>
<h1>Installation</h1>
<h2>Downloads</h2>
<p>Download the latest <a href="https://github.com/Crissium/SilverDict/releases">releases</a> from GitHub. Alternatively, if you are unable to access GitHub, download from <a href="https://nankai.feishu.cn/drive/folder/L43mfggw0l4HLFdBePScUtrbnjb">here</a>.</p>
<h2>Setup</h2>
<p>Please read the <a href="https://github.com/Crissium/SilverDict/wiki/general-notes">guide</a> on GitHub.</p>
</article>
</body>

</html>

0 comments on commit ee81a00

Please sign in to comment.