Skip to content

Commit ec4c0fd

Browse files
committed
refactor: update README to reflect project name change from 'SuperDocs' to 'Lito' and enhance usage instructions
1 parent 23234b4 commit ec4c0fd

File tree

1 file changed

+59
-18
lines changed

1 file changed

+59
-18
lines changed

README.md

Lines changed: 59 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# SuperDocs
1+
# Lito
22

33
The open-source Mintlify alternative. Beautiful documentation sites from Markdown.
44

55
## Features
66

7-
**Simple Setup** - Point to your docs folder and go
7+
**Simple Setup** - Point to your docs folder and go
88
🚀 **Astro-Powered** - Leverages Astro's speed and SEO optimization
99
📝 **Markdown & MDX** - Full support for both formats with frontmatter
1010
🎨 **Customizable Templates** - Use GitHub-hosted or local templates
@@ -17,15 +17,15 @@ The open-source Mintlify alternative. Beautiful documentation sites from Markdow
1717
### Global Installation
1818

1919
```bash
20-
npm install -g @devrohit06/superdocs
20+
npm install -g lito
2121
# or
22-
pnpm add -g @devrohit06/superdocs
22+
pnpm add -g lito
2323
```
2424

2525
### Local Development
2626

2727
```bash
28-
cd superdocs
28+
cd lito
2929
pnpm install
3030
chmod +x bin/cli.js
3131
```
@@ -37,7 +37,7 @@ chmod +x bin/cli.js
3737
Generate a static documentation site:
3838

3939
```bash
40-
superdocs build --input ./my-docs --output ./dist
40+
lito build --input ./my-docs --output ./dist
4141
```
4242

4343
**Options:**
@@ -46,6 +46,8 @@ superdocs build --input ./my-docs --output ./dist
4646
- `-o, --output <path>` - Output directory (default: `./dist`)
4747
- `-t, --template <name>` - Template to use (see [Templates](#templates))
4848
- `-b, --base-url <url>` - Base URL for the site (default: `/`)
49+
- `--provider <name>` - optimize for hosting provider (vercel, netlify, cloudflare, static)
50+
- `--rendering <mode>` - Rendering mode (static, server, hybrid)
4951
- `--search` - Enable search functionality
5052
- `--refresh` - Force re-download template from GitHub
5153

@@ -54,7 +56,7 @@ superdocs build --input ./my-docs --output ./dist
5456
Start a development server with hot reload:
5557

5658
```bash
57-
superdocs dev --input ./my-docs
59+
lito dev --input ./my-docs
5860
```
5961

6062
**Options:**
@@ -71,17 +73,56 @@ superdocs dev --input ./my-docs
7173
Export the full Astro project source code to customize it further:
7274

7375
```bash
74-
superdocs eject --input ./my-docs --output ./my-project
76+
lito eject --input ./my-docs --output ./my-project
77+
```
78+
79+
## Deployment
80+
81+
Lito includes built-in optimizations for major hosting providers. Use the `--provider` flag during build:
82+
83+
### Vercel
84+
```bash
85+
lito build -i ./docs --provider vercel
86+
```
87+
Generates `vercel.json` and optimizes for Vercel's edge network.
88+
89+
### Netlify
90+
```bash
91+
lito build -i ./docs --provider netlify
92+
```
93+
Generates `netlify.toml` with security headers.
94+
95+
### Cloudflare Pages
96+
```bash
97+
lito build -i ./docs --provider cloudflare --rendering server
98+
```
99+
Configures the project for Cloudflare's edge runtime with SSR support.
100+
101+
## Analytics
102+
103+
Lito supports Google Analytics 4 out of the box with zero performance penalty (powered by Partytown).
104+
105+
Add this to your `docs-config.json`:
106+
107+
```json
108+
{
109+
"integrations": {
110+
"analytics": {
111+
"provider": "google-analytics",
112+
"measurementId": "G-XXXXXXXXXX"
113+
}
114+
}
115+
}
75116
```
76117

77118
## Templates
78119

79-
SuperDocs supports flexible template sources:
120+
Lito supports flexible template sources:
80121

81122
### Default Template
82123

83124
```bash
84-
superdocs dev -i ./docs
125+
lito dev -i ./docs
85126
```
86127

87128
### GitHub Templates
@@ -90,39 +131,39 @@ Use templates hosted on GitHub:
90131

91132
```bash
92133
# From a GitHub repo
93-
superdocs dev -i ./docs --template github:owner/repo
134+
lito dev -i ./docs --template github:owner/repo
94135

95136
# Specific branch or tag
96-
superdocs dev -i ./docs --template github:owner/repo#v1.0.0
137+
lito dev -i ./docs --template github:owner/repo#v1.0.0
97138

98139
# Template in a subdirectory
99-
superdocs dev -i ./docs --template github:owner/repo/templates/modern
140+
lito dev -i ./docs --template github:owner/repo/templates/modern
100141
```
101142

102143
### Local Templates
103144

104145
Use a local template folder:
105146

106147
```bash
107-
superdocs dev -i ./docs --template ./my-custom-template
148+
lito dev -i ./docs --template ./my-custom-template
108149
```
109150

110151
### Template Management
111152

112153
```bash
113154
# List available templates
114-
superdocs template list
155+
lito template list
115156

116157
# Clear template cache
117-
superdocs template cache --clear
158+
lito template cache --clear
118159
```
119160

120161
### Update Templates
121162

122163
Templates are cached for 24 hours. Force update with:
123164

124165
```bash
125-
superdocs dev -i ./docs --refresh
166+
lito dev -i ./docs --refresh
126167
```
127168

128169
## Documentation Structure
@@ -171,7 +212,7 @@ The CLI tool:
171212
### Project Structure
172213

173214
```
174-
superdocs/
215+
lito/
175216
├── bin/
176217
│ └── cli.js # CLI entry point
177218
├── src/

0 commit comments

Comments
 (0)