diff --git a/docs/.gitignore b/docs/.gitignore index 6cfbcff..d37f815 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1,3 @@ src/.vitepress/cache/* +src/.vitepress/dist/* node_modules/* \ No newline at end of file diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts index 7e8a338..c47a6c6 100644 --- a/docs/src/.vitepress/config.mts +++ b/docs/src/.vitepress/config.mts @@ -38,63 +38,93 @@ export default defineConfig({ sidebar: [ { text: "About IronCalc", link: "/index.md" }, + { + text: "Web Application", + collapsed: true, + items: [ + { text: "About the web application", link: "/web-application/about" }, + { text: "Importing Files", link: "/web-application/importing-files" }, + { text: "Sharing Files", link: "/web-application/sharing-files" }, + ], + }, { text: "Features", - collapsed: false, + collapsed: true, items: [ { text: "Formatting Values", link: "/features/formatting-values" }, { text: "Using Styles", link: "/features/using-styles" }, { text: "Keyboard Shortcuts", link: "/features/keyboard-shortcuts" }, - { text: "Importing Files", link: "/features/importing-files" }, + { + text: "Error Types", + link: "/features/error-types", + }, + { text: "Unsupported Features", link: "/features/unsupported-features" }, ], }, { text: "Functions", - collapsed: false, + collapsed: true, items: [ - { text: "Database", link: "functions/database" }, - { text: "Date and Time", link: "functions/date-and-time" }, - { text: "Engineering", link: "functions/engineering" }, + { text: "Database", link: "/functions/database" }, + { text: "Date and Time", link: "/functions/date-and-time" }, + { text: "Engineering", link: "/functions/engineering" }, { text: "Financial", collapsed: true, - link: "functions/financial", - items: [{ text: "FV", link: "functions/financial/FV" }], + link: "/functions/financial", + items: [{ text: "FV", link: "/functions/financial/fv" }], }, - { text: "Information", link: "functions/information" }, - { text: "Logical", link: "functions/logical" }, + { text: "Information", link: "/functions/information" }, + { text: "Logical", link: "/functions/logical" }, { text: "Lookup and Reference", - link: "functions/lookup-and-reference", + link: "/functions/lookup-and-reference", }, { text: "Math and Trigonometry", - link: "functions/math-and-trigonometry", + link: "/functions/math-and-trigonometry", }, - { text: "Statistical", link: "functions/statistical" }, - { text: "Text", link: "functions/text" }, + { text: "Statistical", link: "/functions/statistical" }, + { text: "Text", link: "/functions/text" }, ], }, { - text: "Python bindings", + text: "Programming", collapsed: true, items: [ { - text: "Practical Guide", - link: "python-bindings/python-bindings-practical-guide", + text: "Rust", + link: "/programming/rust", + }, + { + text: "Python", + link: "/programming/python-bindings", + }, + { + text: "JavScript", + link: "/programming/javascript-bindings", }, ], }, { - text: "More", + text: "TUI Application: Tironcalc", collapsed: true, items: [ - { text: "Unsupported Features", link: "more/unsupported-features" }, - { text: "How to contribute", link: "more/how-to-contribute" }, { - text: "Understanding Error Types", - link: "more/understanding-error-types", + text: "About Tironcalc", + link: "/tironcalc/about", }, + { + text: "Installing and basic usage", + link: "/tironcalc/installing", + }, + ], + }, + { + text: "Contributing", + collapsed: true, + items: [ + { text: "How to contribute", link: "/contributing/how-to-contribute" }, ], }, ], diff --git a/docs/src/more/how-to-contribute.md b/docs/src/contributing/how-to-contribute.md similarity index 100% rename from docs/src/more/how-to-contribute.md rename to docs/src/contributing/how-to-contribute.md diff --git a/docs/src/more/understanding-error-types.md b/docs/src/features/error-types.md similarity index 94% rename from docs/src/more/understanding-error-types.md rename to docs/src/features/error-types.md index 0b746a7..c392e7b 100644 --- a/docs/src/more/understanding-error-types.md +++ b/docs/src/features/error-types.md @@ -4,7 +4,7 @@ outline: deep lang: en-US --- -# Understanding Excel Error Types +# Error Types ::: warning **Note:** This page is in construction 🚧 @@ -66,6 +66,13 @@ When working with formulas, you may encounter these common errors: **Cause:** Incorrect range operator in a formula (e.g., missing a colon between cell references). **Fix:** Use correct range operators (e.g., A1:A10). + +### **`#CIRC!`** + +**Cause:** Circular reference. +**Fix:** Remove the circular reference. + + ### **`#####`** **Cause:** The column isn’t wide enough to display the value. diff --git a/docs/src/more/unsupported-features.md b/docs/src/features/unsupported-features.md similarity index 100% rename from docs/src/more/unsupported-features.md rename to docs/src/features/unsupported-features.md diff --git a/docs/src/index.md b/docs/src/index.md index 3f55283..01ef9f1 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -3,25 +3,25 @@ layout: doc outline: deep -hero: - name: "IronCalc Documentation" - text: "The documentation of IronCalc" - tagline: My great project tagline - actions: - - theme: brand - text: Markdown Examples - link: /features/markdown-examples - - theme: alt - text: API Examples - link: /features/api-examples +# hero: +# name: "IronCalc Documentation" +# text: "The documentation of IronCalc" +# tagline: My great project tagline +# actions: +# - theme: brand +# text: Markdown Examples +# link: /features/markdown-examples +# - theme: alt +# text: API Examples +# link: /features/api-examples -features: - - title: Feature A - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature B - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature C - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit +# features: +# - title: Feature A +# details: Lorem ipsum dolor sit amet, consectetur adipiscing elit +# - title: Feature B +# details: Lorem ipsum dolor sit amet, consectetur adipiscing elit +# - title: Feature C +# details: Lorem ipsum dolor sit amet, consectetur adipiscing elit --- # About IronCalc diff --git a/docs/src/python-bindings/python-bindings-practical-guide.md b/docs/src/programming/javascript-bindings.md similarity index 74% rename from docs/src/python-bindings/python-bindings-practical-guide.md rename to docs/src/programming/javascript-bindings.md index f8af811..39999d8 100644 --- a/docs/src/python-bindings/python-bindings-practical-guide.md +++ b/docs/src/programming/javascript-bindings.md @@ -4,7 +4,7 @@ outline: deep lang: en-US --- -# Python Bindings, a practical guide +# JavaScript Bindings ::: warning **Note:** This page is in construction 🚧 diff --git a/docs/src/programming/python-bindings.md b/docs/src/programming/python-bindings.md new file mode 100644 index 0000000..ae5773e --- /dev/null +++ b/docs/src/programming/python-bindings.md @@ -0,0 +1,11 @@ +--- +layout: doc +outline: deep +lang: en-US +--- + +# Python Bindings + +::: warning +**Note:** This page is in construction 🚧 +::: diff --git a/docs/src/programming/rust.md b/docs/src/programming/rust.md new file mode 100644 index 0000000..947ae73 --- /dev/null +++ b/docs/src/programming/rust.md @@ -0,0 +1,11 @@ +--- +layout: doc +outline: deep +lang: en-US +--- + +# Rust + +::: warning +**Note:** This page is in construction 🚧 +::: diff --git a/docs/src/tironcalc/about.md b/docs/src/tironcalc/about.md new file mode 100644 index 0000000..c3e9c1b --- /dev/null +++ b/docs/src/tironcalc/about.md @@ -0,0 +1,11 @@ +--- +layout: doc +outline: deep +lang: en-US +--- + +# About Tironcalc + +::: warning +**Note:** This page is in construction 🚧 +::: diff --git a/docs/src/tironcalc/installing.md b/docs/src/tironcalc/installing.md new file mode 100644 index 0000000..6fa3872 --- /dev/null +++ b/docs/src/tironcalc/installing.md @@ -0,0 +1,11 @@ +--- +layout: doc +outline: deep +lang: en-US +--- + +# Installing and running Tironcalc + +::: warning +**Note:** This page is in construction 🚧 +::: diff --git a/docs/src/web-application/about.md b/docs/src/web-application/about.md new file mode 100644 index 0000000..470be2b --- /dev/null +++ b/docs/src/web-application/about.md @@ -0,0 +1,11 @@ +--- +layout: doc +outline: deep +lang: en-US +--- + +# Importing Files + +::: warning +**Note:** This page is in construction 🚧 +::: diff --git a/docs/src/features/importing-files.md b/docs/src/web-application/importing-files.md similarity index 91% rename from docs/src/features/importing-files.md rename to docs/src/web-application/importing-files.md index 99f3a5b..43c0646 100644 --- a/docs/src/features/importing-files.md +++ b/docs/src/web-application/importing-files.md @@ -16,5 +16,5 @@ You can upload files using one of the following methods: - **Click to Upload**: Click on the central upload area and select your file from your device. ::: info -The maximum file size allowed is **1 MB**. +The maximum file size allowed is **10 MB**. ::: diff --git a/docs/src/web-application/sharing-files.md b/docs/src/web-application/sharing-files.md new file mode 100644 index 0000000..8752563 --- /dev/null +++ b/docs/src/web-application/sharing-files.md @@ -0,0 +1,11 @@ +--- +layout: doc +outline: deep +lang: en-US +--- + +# Sharing Files + +::: warning +**Note:** This page is in construction 🚧 +::: \ No newline at end of file