add docs

.gitignore

@@ -1,6 +1,3 @@
-#temp
-docs 
-
 # Ignore logs folder
 logs
 

docs/.gitignore

@@ -0,0 +1,2 @@
+.next
+node_modules

docs/components/counters.module.css

@@ -0,0 +1,6 @@
+.counter {
+ border: 1px solid #ccc;
+ border-radius: 5px;
+ padding: 2px 6px;
+ margin: 12px 0 0;
+}

docs/components/counters.tsx

@@ -0,0 +1,24 @@
+// Example from https://beta.reactjs.org/learn
+
+import { useState } from 'react'
+import styles from './counters.module.css'
+
+function MyButton() {
+ const [count, setCount] = useState(0)
+
+ function handleClick() {
+ setCount(count + 1)
+ }
+
+ return (
+ <div>
+ <button onClick={handleClick} className={styles.counter}>
+ Clicked {count} times
+ </button>
+ </div>
+ )
+}
+
+export default function MyApp() {
+ return <MyButton />
+}

docs/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

docs/next.config.js

@@ -0,0 +1,6 @@
+const withNextra = require('nextra')({
+ theme: 'nextra-theme-docs',
+ themeConfig: './theme.config.tsx',
+})
+
+module.exports = withNextra()

docs/package.json

@@ -0,0 +1,21 @@
+{
+ "name": "rvc_cli",
+ "version": "0.0.1",
+ "description": "🚀 RVC + UVR = A perfect set of tools for voice cloning, easily and free!",
+ "scripts": {
+ "dev": "next dev",
+ "build": "next build",
+ "start": "next start"
+ },
+ "dependencies": {
+ "next": "^13.0.6",
+ "nextra": "latest",
+ "nextra-theme-docs": "latest",
+ "react": "^18.2.0",
+ "react-dom": "^18.2.0"
+ },
+ "devDependencies": {
+ "@types/node": "18.11.10",
+ "typescript": "^4.9.3"
+ }
+}

docs/pages/_meta.json

@@ -0,0 +1,12 @@
+{
+ "index": "Introduction",
+ "installation": "Installation",
+ "rvc": "RVC",
+ "uvr": "UVR",
+ "contact": {
+ "title": "Contact ↗",
+ "type": "page",
+ "href": "https://twitter.com/blaisewf",
+ "newWindow": true
+ }
+}

docs/pages/index.mdx

@@ -0,0 +1,40 @@
+# Introduction
+
+### References
+
+The RVC CLI builds upon the foundations of the following projects:
+
+- **Vocoders:**
+
+ - [HiFi-GAN](https://github.com/jik876/hifi-gan) by jik876
+ - [Vocos](https://github.com/gemelo-ai/vocos) by gemelo-ai
+ - [BigVGAN](https://github.com/NVIDIA/BigVGAN) by NVIDIA
+ - [BigVSAN](https://github.com/sony/bigvsan) by sony
+ - [vocoders](https://github.com/reppy4620/vocoders) by reppy4620
+ - [vocoder](https://github.com/fishaudio/vocoder) by fishaudio
+
+- **VC Clients:**
+
+ - [Retrieval-based-Voice-Conversion-WebUI](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI) by RVC-Project
+ - [So-Vits-SVC](https://github.com/svc-develop-team/so-vits-svc) by svc-develop-team
+ - [Mangio-RVC-Fork](https://github.com/Mangio621/Mangio-RVC-Fork) by Mangio621
+ - [VITS](https://github.com/jaywalnut310/vits) by jaywalnut310
+ - [Harmonify](https://huggingface.co/Eempostor/Harmonify) by Eempostor
+ - [rvc-trainer](https://github.com/thepowerfuldeez/rvc-trainer) by thepowerfuldeez
+
+- **Pitch Extractors:**
+
+ - [RMVPE](https://github.com/Dream-High/RMVPE) by Dream-High
+ - [torchfcpe](https://github.com/CNChTu/FCPE) by CNChTu
+ - [torchcrepe](https://github.com/maxrmorrison/torchcrepe) by maxrmorrison
+ - [anyf0](https://github.com/SoulMelody/anyf0) by SoulMelody
+
+- **Other:**
+ - [FAIRSEQ](https://github.com/facebookresearch/fairseq) by facebookresearch
+ - [FAISS](https://github.com/facebookresearch/faiss) by facebookresearch
+ - [ContentVec](https://github.com/auspicious3000/contentvec/) by auspicious3000
+ - [audio-slicer](https://github.com/openvpi/audio-slicer) by openvpi
+ - [python-audio-separator](https://github.com/karaokenerds/python-audio-separator) by karaokenerds
+ - [ultimatevocalremovergui](https://github.com/Anjok07/ultimatevocalremovergui) by Anjok07
+
+We acknowledge and appreciate the contributions of the respective authors and communities involved in these projects.

docs/pages/installation/linux.mdx

@@ -0,0 +1,3 @@
+# Satori
+
+Satori (悟り) is a Japanese Buddhist term for awakening, "comprehension; understanding".

docs/pages/installation/macos.mdx

@@ -0,0 +1,3 @@
+# Satori
+
+Satori (悟り) is a Japanese Buddhist term for awakening, "comprehension; understanding".

docs/pages/installation/windows.mdx

@@ -0,0 +1,3 @@
+# Satori
+
+Satori (悟り) is a Japanese Buddhist term for awakening, "comprehension; understanding".

docs/pages/uvr.mdx

@@ -0,0 +1,2 @@
+# UVR
+🚧 Page under construction!

docs/theme.config.tsx

@@ -0,0 +1,72 @@
+import React from "react";
+import { DocsThemeConfig, useConfig } from "nextra-theme-docs";
+
+const config: DocsThemeConfig = {
+ logo: 'RVC CLI',
+ search: {
+ placeholder: "What are you looking for? 🧐",
+ },
+ project: {
+ link: "https://github.com/blaisewf/rvc_cli",
+ },
+ chat: {
+ link: "https://discord.gg/iahispano",
+ },
+ docsRepositoryBase: "https://github.com/blaisewf/rvc_cli/tree/main/docs",
+ footer: {
+ text: (
+ <span>
+ made w ❤️ by blaisewf
+ </span>
+ ),
+ },
+ nextThemes: {
+ defaultTheme: "dark",
+ },
+ feedback: {
+ content: "Do you think we should improve something? Let us know!",
+
+ },
+ editLink: {
+ component: null,
+ },
+ faviconGlyph: "favicon.ico",
+ logoLink: "/",
+ primaryHue: 317,
+ head: () => {
+ const { frontMatter } = useConfig();
+
+ return (
+ <>
+ <meta name="msapplication-TileColor" content="#fff" />
+ <meta name="theme-color" content="#111" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta httpEquiv="Content-Language" content="en" />
+ <meta
+ name="description"
+ content="🚀 RVC + UVR = A perfect set of tools for voice cloning, easily and free!"
+ />
+ <meta
+ name="og:description"
+ content="🚀 RVC + UVR = A perfect set of tools for voice cloning, easily and free!"
+ />
+ <meta name="twitter:card" content="summary_large_image" />
+ <meta name="twitter:site:domain" content="https://rvc_cli.github.io" />
+ <meta name="twitter:url" content="https://rvc_cli.github.io" />
+ <meta
+ name="og:title"
+ content={frontMatter.title || 'RVC CLI'}
+ />
+ <meta name="apple-mobile-web-app-title" content="RVC CLI" />
+ <link rel="icon" href="/favicon.ico" sizes="any" />
+ </>
+ );
+ },
+ useNextSeoProps() {
+ return {
+ titleTemplate: `%s - RVC CLI`,
+ };
+ },
+};
+
+export default config;

docs/tsconfig.json

@@ -0,0 +1,20 @@
+{
+ "compilerOptions": {
+ "target": "es5",
+ "lib": ["dom", "dom.iterable", "esnext"],
+ "allowJs": true,
+ "skipLibCheck": true,
+ "strict": false,
+ "forceConsistentCasingInFileNames": true,
+ "noEmit": true,
+ "incremental": true,
+ "esModuleInterop": true,
+ "module": "esnext",
+ "moduleResolution": "node",
+ "resolveJsonModule": true,
+ "isolatedModules": true,
+ "jsx": "preserve"
+ },
+ "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
+ "exclude": ["node_modules"]
+}