Merge pull request #3 from kevinramage/develop

v0.0.3 - Init markdown editor
kevinramage · Oct 7, 2024 · b633683 · b633683
2 parents 712c88f + ccde8c2
commit b633683
Show file tree

Hide file tree

Showing 24 changed files with 1,933 additions and 871 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,9 +8,11 @@ pnpm-debug.log*
 lerna-debug.log*
 
 node_modules
+node_modules2
 dist
 dist-ssr
 *.local
+tsconfig.tsbuildinfo
 
 binaries
 target

diff --git a/README.md b/README.md
@@ -1,16 +1,32 @@
 # Knownledga
 
+Knownledga is  a tool to read and write markdown files.
+
 ## Installation
 
+Install dependencies:
+
+```
 npm update
 npm update -D
 npm install -g pnpm
+```
+
 Download rust
 
-## Run
+## Run and build
 
+Run client
+```
 pnpm tauri dev
+```
+
+Build a release
+```
+pnpm tauri build
+```
 
-## Build
+## Compatibility
 
-pnpm tauri build
+[Markdown rendering compatibility](./doc/markdown.md)
+[Mermaid rendering compatibility](./doc/markdown.md)
diff --git a/common/document.ts b/common/document.ts
@@ -2,6 +2,10 @@ export interface IDocument {
     id: string;
     name: string;
     path: string;
+    relativePath: string;
     content: string;
-    /*subDocuments: IDocument[];*/
-}
+    type: DOCUMENT_TYPE;
+    subDocuments: IDocument[];
+}
+
+export type DOCUMENT_TYPE = "FOLDER" | "MARKDOWN" | "UNKNOWN";
diff --git a/doc/markdown.md b/doc/markdown.md
@@ -0,0 +1,47 @@
+# Markdown support
+
+- [x] Paragraph
+- [x] Heading
+- [x] Alternative heading syntax
+- [x] Paragraph line break
+- [x] Bold syntax with *
+- [x] Bold syntax with _
+- [x] Italic syntax with *
+- [x] Italic syntax with _
+- [x] Blockquote
+- [ ] Blockquote Multiple paragraphe (Not compatible yet)
+- [ ] Nested blockquote (Not compatible yet)
+- [x] Ordered list
+- [x] Ordered sub list
+- [x] Nonordered list
+- [x] Nonordered sub list
+- [ ] Local images (Not compatible yet)
+- [ ] External images (Not compatible yet)
+- [x] Internal links
+- [x] External links
+- [ ] Code (Not compatible yet)
+- [ ] Horizontal rules (Not compatible yet)
+- [ ] Formatting url and mail (Not compatible yet)
+- [ ] Escaping character (Not compatible yet)
+- [ ] Html (Not compatible yet)
+
+[Source](https://www.markdownguide.org/basic-syntax/#code)
+--------------------
+
+- [ ] Table (Partial not compatible with inline tokens)
+- [ ] Table alignment (Not compatible yet)
+- [x] Fences code block
+- [ ] Syntax highlighting (Not compatible yet)
+- [ ] Footnote (Not compatible yet)
+- [ ] Heading id (Not compatible yet)
+- [ ] Definition list (Not compatible yet)
+- [x] Strikethrough
+- [ ] Task list (Partial not compatible with inline tokens)
+- [ ] Sub task list (Not compatible yet)
+- [ ] Emoji (Not compatible yet)
+- [ ] Highlight (Not compatible yet)
+- [ ] Subscript (Not compatible yet)
+- [ ] Superscript (Not compatible yet)
+- [ ] Automatic URL linking (Not compatible yet)
+
+[Source](https://www.markdownguide.org/extended-syntax/)
diff --git a/doc/mermaid.md b/doc/mermaid.md
@@ -40,4 +40,5 @@
     - [ ] New shapes 11.3
 
 
-[Source](https://mermaid.js.org/syntax/flowchart.html#a-stadium-shaped-node)
+[Mermaid source](https://mermaid.js.org/syntax/flowchart.html#a-stadium-shaped-node)
+[Quoto source](https://quarto.org/docs/authoring/diagrams.html)
diff --git a/doc/version.md b/doc/version.md
@@ -13,13 +13,14 @@ This document help to understand the content of each versions
 
 **V 0.0.2 - File explorer**
 
-- [X] Create a new file
-- [X] Delete a file
-- [X] Update exiting file
-- [X] Initialize Mermaid FlowChart rendering
+- [x] Create a new file
+- [x] Delete a file
+- [x] Update exiting file
+- [x] Initialize Mermaid FlowChart rendering
 
 **V 0.0.3 - Markdown toolbar**
 
-- [ ] View directory in file explore
+- [x] Reduce binaries size
+- [x] View directory in file explore
 - [ ] Add markdown editor WYSIWYG for basic feature
 - [ ] Add Mermaid FlowChart relationship rendering
diff --git a/index.html b/index.html
@@ -4,10 +4,11 @@
     <meta charset="UTF-8" />
     <link rel="icon" type="image/svg+xml" href="/vite.svg" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vite + React + TS</title>
+    <title>Knowledga</title>
   </head>
   <body>
     <div id="root"></div>
     <script type="module" src="/src/main.tsx"></script>
+    <link href="./src/index.css" rel="stylesheet" />
   </body>
 </html>