Skip to content

Commit ca66bb9

Browse files
Merge pull request #22 from programmablemd/develop
chore: upgrade fumadocs to latest version
2 parents 687a039 + 93439d9 commit ca66bb9

6 files changed

Lines changed: 503 additions & 216 deletions

File tree

content/docs/getting-started/installation.mdx

Lines changed: 3 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -97,100 +97,23 @@ spry-runbook --version
9797
spry-runbook --help
9898
```
9999

100-
101-
## Installation By using Deno.
102-
**Prerequisites:**
103-
104-
Before installing Spry, make sure you have the following installed on your system:
105-
106-
- **Deno:** Spry runs on the Deno runtime (v1.30 or later)
107-
- **Database:** SQLite or PostgreSQL
108-
- **SQLPage (optional):** For building web applications
109-
### Installing Deno
110-
111-
Spry is built on Deno, a modern JavaScript/TypeScript runtime. Install it using the following command:
112-
113-
<Tabs items={['macOS / Linux', 'Windows']}>
114-
<Tab value="macOS / Linux">
115-
```bash
116-
curl -fsSL https://deno.land/install.sh | sh
117-
```
118-
</Tab>
119-
<Tab value="Windows">
120-
```powershell
121-
irm https://deno.land/install.ps1 | iex
122-
```
123-
</Tab>
124-
</Tabs>
125-
126-
<Callout type="info" title="Verify Installation">
127-
After installation, verify Deno is installed correctly by running: `deno --version`
128-
</Callout>
129-
130-
### Installing Spry
131-
132-
Initialize a new Spry project using the installation script. Choose your preferred database:
133-
134-
<Tabs items={['SQLite', 'PostgreSQL']}>
135-
<Tab value="SQLite">
136-
### SQLite Setup
137-
138-
Create a new Spry project with SQLite (default):
139-
140-
```bash
141-
curl -fsSL https://sprymd.org/init.sh | sh -s
142-
```
143-
144-
This creates a new Spry project in the current directory with SQLite configuration.
145-
146-
<Callout>
147-
SQLite is perfect for development and small to medium applications. No separate database server required!
148-
</Callout>
149-
</Tab>
150-
151-
<Tab value="PostgreSQL">
152-
### PostgreSQL Setup
153-
154-
Create a new Spry project with PostgreSQL:
155-
156-
```bash
157-
curl -fsSL https://sprymd.org/init.sh | sh -s -- --dialect postgres
158-
```
159-
160-
### Custom Directory
161-
162-
Specify a custom target directory:
163-
164-
```bash
165-
curl -fsSL https://sprymd.org/init.sh | sh -s -- --target-dir myproject --dialect postgres
166-
```
167-
168-
<Callout type="info">
169-
PostgreSQL is recommended for production deployments and applications requiring advanced database features.
170-
</Callout>
171-
</Tab>
172-
</Tabs>
173-
174100
### Project Structure
175101

176-
After initialization, your project will have the following structure:
102+
After initialization (using `spry sp init`), your project will have the following structure:
177103

178104
```text
179105
myproject/
180106
├── Spryfile.md # Main executable markdown file
181107
├── spry.ts # Spry CLI
182-
├── sqlpage/
183-
│ ├── sqlpage.json # SQLPage configuration
184-
│ └── migrations/ # Database migrations
185-
└── dev-src.auto/ # Auto-generated SQLPage source files
108+
├── import_map.json # Import map To access Spry scripts from a remote folder
186109
```
187110

188111
### Verify Installation
189112

190113
Test your Spry installation:
191114

192115
```bash
193-
./spry.ts --version
116+
spry --version
194117
```
195118

196119
You should see the Spry version number printed to the console.

content/docs/getting-started/quick-start.mdx

Lines changed: 9 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,13 @@ import { Steps, Step } from 'fumadocs-ui/components/steps';
1111
import { Card, Cards } from 'fumadocs-ui/components/card';
1212

1313
This guide will walk you through creating and deploying your first SQLPage application using Spry.
14-
<Tabs items={['Installation using Executable Package', 'Installation using Deno']}>
15-
<Tab value="Installation using Executable Package">
14+
1615
<Callout>
1716
Make sure you've completed the <a href="/docs/getting-started/installation#installation-of-executable-package" target="_blank" rel="noopener noreferrer">installation</a> steps before continuing.
1817
* Go to the project location where you want to create your Spry application.
1918
* Create a Spryfile.md file with sqlpage configuration using the following command.
2019
```bash
21-
spry-sqlpage init
20+
spry sp init
2221
```
2322
For SQLite and PostgreSQL DB ensure the below content is available in Spryfile.md
2423
```text
@@ -49,7 +48,7 @@ This guide will walk you through creating and deploying your first SQLPage appli
4948
Generate the SQLPage source files from your Spryfile.md:
5049

5150
```bash
52-
spry-sqlpage spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json
51+
spry sp spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json
5352
```
5453
</Step>
5554

@@ -59,7 +58,7 @@ This guide will walk you through creating and deploying your first SQLPage appli
5958
Run Spry in watch mode for live reloading:
6059

6160
```bash
62-
spry-sqlpage spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json --watch
61+
spry sp spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json --watch
6362
```
6463

6564
<Callout type="info" title="Auto-Reload">
@@ -73,7 +72,7 @@ This guide will walk you through creating and deploying your first SQLPage appli
7372
Deploy SQLPage components to your SQLite database:
7473

7574
```bash
76-
spry-sqlpage task deploy
75+
spry rb task deploy
7776
```
7877
</Step>
7978

@@ -108,23 +107,23 @@ This guide will walk you through creating and deploying your first SQLPage appli
108107
### Generate SQLPage Source Files
109108

110109
```bash
111-
spry-sqlpage spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json
110+
spry sp spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json
112111
```
113112
</Step>
114113

115114
<Step key="start-dev-ser">
116115
### Start Development Server
117116

118117
```bash
119-
spry-sqlpage spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json --watch
118+
spry sp spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json --watch
120119
```
121120
</Step>
122121

123122
<Step key="dep-database">
124123
### Deploy to Database
125124

126125
```bash
127-
spry-sqlpage task deploy
126+
spry rb task deploy
128127
```
129128
</Step>
130129

@@ -138,119 +137,7 @@ This guide will walk you through creating and deploying your first SQLPage appli
138137
</Steps>
139138
</Tab>
140139
</Tabs>
141-
</Tab>
142-
<Tab value="Installation using Deno">
143-
<Callout>
144-
Make sure you've completed the <a href="/docs/getting-started/installation#installation-by-using-deno" target="_blank" rel="noopener noreferrer">installation</a> steps before continuing.
145-
</Callout>
146-
147-
## Installation using Deno: Development Workflow
148-
149-
Follow these steps to generate SQLPage assets and start the development server:
150-
151-
<Tabs items={['SQLite', 'PostgreSQL']}>
152-
<Tab value="SQLite">
153-
### SQLite Setup
154-
155-
<Steps>
156-
<Step key="gene-sql">
157-
### Generate SQLPage Source Files
158-
159-
Generate the SQLPage source files from your Spryfile.md:
160-
161-
```bash
162-
./spry.ts spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json
163-
```
164-
</Step>
165-
166-
<Step key="start-dev">
167-
### Start Development Server
168-
169-
Run Spry in watch mode for live reloading:
170-
171-
```bash
172-
./spry.ts spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json --watch
173-
```
174-
175-
<Callout type="info" title="Auto-Reload">
176-
The `--watch` flag automatically regenerates files when your Spryfile.md changes!
177-
</Callout>
178-
</Step>
179-
180-
<Step key="dep-db">
181-
### Deploy to Database
182-
183-
Deploy SQLPage components to your SQLite database:
184-
185-
```bash
186-
./spry.ts task deploy
187-
```
188-
</Step>
189-
190-
<Step key="st-ser">
191-
### Start SQLPage Server
192-
193-
Launch the SQLPage server:
194-
195-
```bash
196-
SQLPAGE_SITE_PREFIX="" sqlpage
197-
```
198-
199-
Your application will be available at `http://localhost:8080`
200-
</Step>
201-
</Steps>
202-
</Tab>
203-
204-
<Tab value="PostgreSQL">
205-
### PostgreSQL Setup
206-
207-
<Steps>
208-
<Step key="set-db">
209-
### Set Database Connection
210-
211-
Configure your PostgreSQL connection string:
212-
213-
```bash
214-
export DATABASE_URL="postgresql://user:password@localhost:5432/mydb"
215-
```
216-
</Step>
217-
218-
<Step key="gen-sql-page">
219-
### Generate SQLPage Source Files
220-
221-
```bash
222-
./spry.ts spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json
223-
```
224-
</Step>
225-
226-
<Step key="start-dev-ser">
227-
### Start Development Server
228-
229-
```bash
230-
./spry.ts spc --fs dev-src.auto --destroy-first --conf sqlpage/sqlpage.json --watch
231-
```
232-
</Step>
233-
234-
<Step key="dep-database">
235-
### Deploy to Database
236-
237-
```bash
238-
./spry.ts task deploy
239-
```
240-
</Step>
241-
242-
<Step key="start-sq">
243-
### Start SQLPage Server
244-
245-
```bash
246-
SQLPAGE_SITE_PREFIX="" sqlpage
247-
```
248-
</Step>
249-
</Steps>
250-
</Tab>
251-
</Tabs>
252-
</Tab>
253-
</Tabs>
140+
254141

255142
## Your First Spryfile
256143

content/docs/reference-guides/cli/meta.json

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,9 @@
22
"title": "CLI",
33
"defaultOpen": false,
44
"pages": [
5-
"help",
6-
"init",
7-
"doctor",
8-
"mdast",
9-
"spc",
105
"sp",
11-
"task",
12-
"runbook",
13-
"qualityfolio-cli",
14-
"version"
6+
"options",
7+
"spry-axiom"
158
]
16-
}
9+
}
10+
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Options of Spry
3+
description: Spry CLI Options (Help and Version)
4+
icon: HandHelping
5+
index: 0
6+
---
7+
8+
# Spry CLI Options
9+
10+
Spry is a CLI tool for working with executable Markdown and the Spry ecosystem. ([GitHub][1])
11+
12+
Below is a reference for the top-level **CLI options** available when using the `spry` command.
13+
14+
## Usage
15+
16+
```sh
17+
spry [options]
18+
```
19+
20+
## Global Options
21+
22+
These options modify Spry’s behavior or show information about the program.
23+
24+
| Flag | Alias | Description |
25+
| ---- | ----------- | ------------------------------------------------------------------------------------------------------------------- |
26+
| `-h` | `--help` | **Show help** — Prints general help information about the Spry CLI, including usage and available commands/options. |
27+
| `-V` | `--version` | **Show version** — Displays the current version of the Spry CLI. |
28+
29+
## Example
30+
31+
```sh
32+
# Display usage and help
33+
spry -h
34+
spry --help
35+
36+
# Print the Spry CLI version
37+
spry -V
38+
spry --version
39+
```
40+
41+
## Notes
42+
* The `--help` option is helpful for quickly seeing usage and available commands if you’re unsure what you can run.
43+
44+
---

0 commit comments

Comments
 (0)