th3r00t/pyShelf
1
0
Fork 0
mirror of https://github.com/th3r00t/pyShelf.git synced 2026-04-28 01:59:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Push for Pages.

Browse Source
This commit is contained in:
th3r00t
2023-03-17 19:46:25 -04:00
parent 008eb71ac7
commit a5045a3a2e
22 changed files with 1634 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
docs/index.html Normal file
View File

@@ -0,0 +1,133 @@
<!DOCTYPE html>
<html>
<head>
<link rel="Stylesheet" type="text/css" href="style.css">
<link rel="alternate" type="application/rss+xml" title="RSS" href="rss.xml">
<title>index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<p>
<a href="TOC.html">TOC</a> <a href="https://github.com/th3r00t/pyShelf.git">github</a>
</p>
<div id="pyShelf | project:pyshelf"><h1 id="pyShelf | project:pyshelf" class="header"><a href="#pyShelf | project:pyshelf">pyShelf | project:pyshelf</a></h1></div>
<p>
<img src="/home/th3r00t/.local/builds/pyShelf/src/frontend/static/images/png/logo-no-background.png" />
</p>
<p>
Version 0.7.0
<a href="License.html">GPLv3</a>
</p>
<p>
pyShelf is an open source ebook server written in Python.
It is designed with ease of use in mind.
</p>
<div id="pyShelf | project:pyshelf-Branches"><h2 id="Branches" class="header"><a href="#pyShelf | project:pyshelf-Branches">Branches</a></h2></div>
<ul>
<li>
<span id="pyShelf | project:pyshelf-Branches-Master"></span><strong id="Master">Master</strong> is the most stable branch, but may be behind in features.
<li>
<span id="pyShelf | project:pyshelf-Branches-Dev"></span><strong id="Dev">Dev</strong> is the most active branch, this branch is a rolling release branch.
<li>
<span id="pyShelf | project:pyshelf-Branches---"></span><strong id="--">--</strong>* are used for day to day development.
</ul>
<div id="pyShelf | project:pyshelf-Formats"><h2 id="Formats" class="header"><a href="#pyShelf | project:pyshelf-Formats">Formats</a></h2></div>
<p>
pyShelf supports the following formats:
</p>
<ul>
<li>
epub
<li>
mobi
<li>
pdf
</ul>
<div id="pyShelf | project:pyshelf-Services"><h2 id="Services" class="header"><a href="#pyShelf | project:pyshelf-Services">Services</a></h2></div>
<ul>
<li>
Backend
<ul>
<li>
<a href="Book Scraping System.html">Book Scraper</a>
<li>
<a href="OPDS.html">OPDS</a>
</ul>
<li>
Filesystem-io
<ul>
<li>
<a href="Book Attachment System.html">Book Attachment System</a>
</ul>
<li>
<a href="Frontend.html">Frontend</a>
<ul>
<li>
<a href="REST API.html">RESTAPI</a>
<li>
<a href="Frontend.html#Dependency Management">Dependency Management</a>
<li>
<a href="Frontend.html#User Management">User Management</a>
<li>
<a href="Frontend.html#User Experience">User Experience</a>
<li>
<a href="Frontend.html#Data Management">Data Management</a>
</ul>
</ul>
<div id="pyShelf | project:pyshelf-TODO"><h2 id="TODO" class="header"><a href="#pyShelf | project:pyshelf-TODO"><span class="todo">TODO</span></a></h2></div>
<ul>
<li class="done0">
<a href="Book Scraping System.html">Book Scraping System</a> #6bc7b0b2
<li class="done0">
<a href="REST API.html">REST API</a> #f228623c
<li class="done0">
<a href="Frontend.html">Frontend</a> #c1681179
</ul>
<div id="pyShelf | project:pyshelf-Development"><h2 id="Development" class="header"><a href="#pyShelf | project:pyshelf-Development">Development</a></h2></div>
<p>
pyShelf takes advantage of the following tools:
</p>
<p>
<a href="https://pre-commit.com/">pre-commit</a> <a href="http://www.doxygen.nl/">doxygen</a> &amp;
<a href="https://vimwiki.github.io/">VimWiki</a> we also follow
<a href="https://semver.org">semver</a> standards.
</p>
<p>
Please note that I use task, vimwiki, &amp; taskwiki to manage my projects.
Due to this Task entries marked via <code>* [ ] task</code> are postfixed with hex color
data. Anyone who knows how to fix that I'm all ears :).
</p>
</body>
</html>