Reconstruct

docs/.vitepress/config.mts

@@ -2,27 +2,48 @@ import { defineConfig } from 'vitepress'
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  title: "Rhythm Sheet Editor",
+  title: "RT Sheet Editor",
   description: "Documentation",
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' }
+      { text: 'Docs', link: '/What-is-this' }
     ],
-
     sidebar: [
       {
-        text: 'Examples',
+        text: 'Introduction',
         items: [
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' }
+          { text: 'RT Sheet Editor', link: '/What-is-this' },
+          { text: 'Getting Started', link: '/Getting-stardet' }
+        ]
+      },
+      {
+        text: 'Interface',
+        items:[
+          {text: 'Home page', link: '/Home'},
+          {text: 'Sheet editor page', link: '/Sheet-editor'}
         ]
-      }
+      },
+      /*{
+        text: 'Tutorials and Guides',
+        items:[
+          {
+            text: 'Guides',
+            items:[
+              {text: 'Launch project', link:'/Guides/1'}
+            ]
+          }
+        ]
+      }*/
     ],
-
+    footer: {
+      message: 'Get for Windows, MacOS and Linux',
+      copyright: 'Rhythm Sheet Editor. Copyright © 2024 EpicAlios (Alain Kouya).'
+    },
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+      { icon: 'discord', link: 'https://discord.gg/fJNpNCJ2b9' }
     ]
-  }
+  },
+
 })

docs/.vitepress/theme/index.ts

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme

docs/.vitepress/theme/style.css

@@ -0,0 +1,139 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ * 
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: var(--vp-c-brand-3);
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: var(--vp-c-brand-2);
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: var(--vp-c-brand-1);
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #8a73ff 30%,
+    #8a73ff
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #8a73ff 50%,
+    #8a73ff 50%
+  );
+  --vp-home-hero-image-filter: blur(44px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+

docs/Getting-stardet.md

@@ -0,0 +1,34 @@
+# Getting Started with RT Sheet Editor
+
+## Step 1: Install RT Sheet Editor
+
+RT Sheet Editor is available for all major operating systems, including the latest versions of Windows, macOS, and Linux. To download RT Sheet Editor
+
+The installation instructions depend on the operating system.
+
+**Windows:**
+
+Double-click on the executable.
+Click on the Next button several times, until the installation begins. This installs RT Sheet Editor, launches the app, and adds an icon to the Desktop.
+
+**macOS:**
+
+Open the DMG file.
+
+**Linux (AppImage):**
+
+Open a terminal.
+Make the AppImage file executable by typing .chmod a+x RT-Sheet-Editor*.AppImage
+
+## Step 2: Create a new project
+
+1. Launch RT Sheet Editor.
+
+2. Either click on **New project** to start from an empty project.
+
+3. Choose a location and name for the project, and audio file to start a new project.
+
+
+![An image](./assets/Home.png)
+
+![An image](./assets/NewProject.png)

docs/Guides.md

@@ -0,0 +1,18 @@
+# Create a project
+# Open a project that is not in recent projects
+# Configure this sheet at project launch 
+# Create notes
+# Modify note creation keys
+# Moving on the sheet
+# Move notes
+# Modify note duration
+# Locate a note using the mapping list
+# Delete a note
+# Detect music bpm
+# Pin notes to grid
+# Create a new sheet
+# Modify sheet parameters
+# Delete a sheet
+# Modify music playback speed
+# Save your project
+# Export project as JSON

docs/Home.md

@@ -0,0 +1,25 @@
+# Home page
+
+## Create a new project.
+
+Start creating your new project. (Use the cursor) 
+- Click on "New project".
+- A panel opens, asking you to fill in the various details of your project.
+- Finally, click on "Create".
+
+![An image](./assets/HomePageImg.png)
+
+## Load an existing project.
+
+Return to previous projects and continue working on your creations. Easily load existing projects to make changes or add new elements.To do this:
+- Click on "Load project".
+- A dialog window will open, allowing you to select the project.
+- Finally, click on "Ouvrir" ("Open") :satisfied:
+
+![An image](./assets/LoadProject.png)
+
+## Continue a recently opened project.
+
+Get quick access to the projects you've recently worked on with the recent projects list. Pick up where you left off.
+
+![An image](./assets/LatestProject.png)