obsidian-plugin/h-sphere_sql-seal
1
0
Fork 0
mirror of https://github.com/h-sphere/sql-seal.git synced 2026-07-22 05:12:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fixing documentation

Browse source
This commit is contained in:
Kacper Kula 2024-05-05 22:40:58 +01:00
parent 7498a032bc
commit c1754f8436
4 changed files with 5 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -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).
For more comprehensive documentation head to [hypersphere.blog/sql-seal](https://hypersphere.blog/sql-seal).

1
docs/.vitepress/config.mts
View file

@ -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' }

55
docs/getting-started.md
View file

@ -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).

7
docs/quick-start.md
View file

@ -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 <URL>
```
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)