diff --git a/README.md b/README.md index f345e97..16d0f70 100644 --- a/README.md +++ b/README.md @@ -23,4 +23,5 @@ SELECT * FROM transactions LIMIT 10 The code above will create table called `transactions` based on the `transactions.csv` file from your vault. Further you can refer to it using regular `SELECT` statements. You can define multiple tables in a single snippet. You can also point to the tables defined in different snippets *within the same note* (for now tables stay local to the file). -For more comprehensive documentation head to [hypersphere.blog/sql-seal](https://hypersphere.blog/sql-seal). \ No newline at end of file +For more comprehensive documentation head to [hypersphere.blog/sql-seal](https://hypersphere.blog/sql-seal). + diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 453e9fe..dad87f5 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -16,7 +16,6 @@ export default defineConfig({ { text: 'Documentation', items: [ - { text: 'Getting Started', link: '/getting-started' }, { text: 'Quick Start', link: '/quick-start' }, { text: 'Using properties', link: '/using-properties' }, { text: 'Future Plans', link: '/future-plans' } diff --git a/docs/getting-started.md b/docs/getting-started.md deleted file mode 100644 index eb32240..0000000 --- a/docs/getting-started.md +++ /dev/null @@ -1,55 +0,0 @@ -# Getting Started - - - -## Custom Containers - -**Input** - -```md -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: -``` - -**Output** - -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: - -## More - -Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown). diff --git a/docs/quick-start.md b/docs/quick-start.md index d2b5ced..e4beb3a 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -8,10 +8,9 @@ In this guide you will learn: The easiest way to install SQLSeal is to download it from Community Plugins. Go to Settings -> Community Plugins and click on Browse button. Search for SQLSeal, install it and enable. ### Manual instalation -To install it manually clone the project: -```bash -git clone -``` +To manually instal the package, open [Releases](https://github.com/h-sphere/sql-seal/releases) and download .zip of the last one. Unzip it in your vault under `.obsidian/Plugins/sqlseal`. + +Once the library is published in Obsidian Official Community Repository: just head to Community Tab in your Obisidian Settings page and search for "SQLSeal". ## Save CSV in Obsidian Obsidian does not natively support CSV and it hides them in the file explorer. To enable CSVs being shown on the sidebar, you need to enable "Detect all file extensions" in "Files and Links" setting panel. Then save the following CSV in your vault: [transactions.csv](./transactions.csv)