Update docs to use markdown files

This commit is contained in:
advplyr 2022-12-24 11:04:20 -06:00
parent 205f761a08
commit 7735bf57f0
35 changed files with 390 additions and 240 deletions

View file

@ -1,10 +1,5 @@
<template>
<div id="book-title-folder" class="py-10 md:py-20">
<h1 class="text-xl md:text-3xl mb-4 md:-ml-8">
<nuxt-link to="#book-title-folder"><span class="material-icons text-lg md:text-xl text-gray-400 hover:text-white cursor-pointer mr-2">tag</span></nuxt-link
>Title Folder Naming
</h1>
<div id="book-title-folder" class="not-prose">
<p class="mb-4">In addition to the book title, the title folder can include the publish year, volume number, the subtitle, and the narrator.</p>
<p class="mb-4">Here are a bunch of ways the same book could be named:</p>
@ -43,7 +38,7 @@
</div>
<div class="flex py-1">
<img src="/folder.svg" class="h-6" />
<p class="pl-2">Vol. 1 - 1994 - Wizards First Rule - A Really Good Subtitle {Sam Tsoutsouvas}</p>
<p class="pl-2">Vol. 1 - 1994 - Wizards First Rule - A Really Good Subtitle {Sam Tsoutsouvas}</p>
</div>
<div class="flex py-1">
<img src="/folder.svg" class="h-6" />
@ -60,15 +55,23 @@
</div>
<ul class="list-outside md:list-inside px-6 md:px-0 list-disc my-4 text-sm md:text-base">
<li class="py-1"><strong><u>Subtitle</u>:</strong> Parsing out subtitles into a separate field is optional and must be enabled in settings. Subtitle must be separated by " - ".</li>
<li class="py-1"><strong><u>Volume Number</u>:</strong> Case insensitive & decimals supported.</li>
<ul>
<li style="padding-left: 3em">The volume number can be placed anywhere in the folder name.</li>
<li style="padding-left: 3em">It must be followed by " - " or ". "</li>
<li style="padding-left: 3em">If it is not at the beginning of the folder name, it must be preceded by " - " and "Vol" "Vol." "Volume" or "Book"</li>
</ul>
<li class="py-1"><strong><u>Publish Year</u>:</strong> The publish year must be the first part of the name OR directly after a volume number, and separated by " - " on both sides.</li>
<li class="py-1"><strong><u>Discs and Disc Numbers</u>:</strong> You have to name each folder in the format of CD1, CD01, or CD001; Disk Folder support is not fully supported yet.</li>
<li class="py-1">
<strong><u>Subtitle</u>:</strong> Parsing out subtitles into a separate field is optional and must be enabled in settings. Subtitle must be separated by " - ".
</li>
<li class="py-1">
<strong><u>Volume Number</u>:</strong> Case insensitive & decimals supported.
</li>
<ul>
<li style="padding-left: 3em">The volume number can be placed anywhere in the folder name.</li>
<li style="padding-left: 3em">It must be followed by " - " or ". "</li>
<li style="padding-left: 3em">If it is not at the beginning of the folder name, it must be preceded by " - " and "Vol" "Vol." "Volume" or "Book"</li>
</ul>
<li class="py-1">
<strong><u>Publish Year</u>:</strong> The publish year must be the first part of the name OR directly after a volume number, and separated by " - " on both sides.
</li>
<li class="py-1">
<strong><u>Discs and Disc Numbers</u>:</strong> You have to name each folder in the format of CD1, CD01, or CD001; Disk Folder support is not fully supported yet.
</li>
</ul>
</div>
</template>