Skip to content

Commit 1289a4b

Browse files
committed
docs: updated content
1 parent e22f0df commit 1289a4b

File tree

7 files changed

+42
-72
lines changed

7 files changed

+42
-72
lines changed

README.md

+7-45
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,19 @@
1-
# Docus Starter
1+
# Hoppscotch Documentation
22

3-
Starter template for [Docus](https://docus.dev).
3+
Docs are powered by [Docus](https://docus.dev).
44

5-
## Clone
6-
7-
Clone the repository (using `nuxi`):
8-
9-
```bash
10-
npx nuxi init -t themes/docus
11-
```
12-
13-
## Setup
5+
## Local Development
146

157
Install dependencies:
168

179
```bash
18-
yarn install
19-
```
20-
21-
## Development
22-
23-
```bash
24-
yarn dev
10+
pnpm install
2511
```
2612

27-
## Edge Side Rendering
28-
29-
Can be deployed to Vercel Functions, Netlify Functions, AWS, and most Node-compatible environments.
30-
31-
Look at all the available presets [here](https://v3.nuxtjs.org/guide/deploy/presets).
13+
Start development server with:
3214

3315
```bash
34-
yarn build
16+
pnpm run dev
3517
```
3618

37-
## Static Generation
38-
39-
Use the `generate` command to build your application.
40-
41-
The HTML files will be generated in the .output/public directory and ready to be deployed to any static compatible hosting.
42-
43-
```bash
44-
yarn generate
45-
```
46-
47-
## Preview build
48-
49-
You might want to preview the result of your build locally, to do so, run the following command:
50-
51-
```bash
52-
yarn preview
53-
```
54-
55-
---
56-
57-
For a detailed explanation of how things work, check out [Docus](https://docus.dev).
19+
Start editing [conent](./content) directory!

components/content/Image.vue

+1-8
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ const colorMode = useColorMode()
4949
<style>
5050
.image-zoomable {
5151
border: 1px solid var(--elements-border-secondary-static) !important;
52-
border-radius: var(--radii-md) !important;
52+
border-radius: var(--radii-xs) !important;
5353
}
5454
5555
.medium-zoom-overlay {
@@ -58,13 +58,6 @@ const colorMode = useColorMode()
5858
}
5959
6060
.medium-zoom-image--opened {
61-
border-radius: var(--radii-xs) !important;
6261
z-index: 1000 !important;
6362
}
64-
65-
.callout.alert {
66-
background-color: var(--docus-body-backgroundColor) !important;
67-
border: 1px solid var(--elements-border-secondary-static) !important;
68-
border-radius: var(--radii-md) !important;
69-
}
7063
</style>

content/1.documentation/4.features/8.collections.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@ To create a new collection, click on the "**Add new**" button on the collections
2525
To add a new request to you collection, you can click on the "**Save**" button on the request page and select the collection you want to add it to. Click on the drop down menu next to save button and click on "**Save as**" to save the request to a new location.
2626

2727
::alert{type="info"}
28+
::list{type="info"}
2829

29-
You can also use the keyboard shortcut <kbd>`ctrl/cmd`</kbd> + <kbd>`S`</kbd> to save the request to a collection.
30+
- You can also use the keyboard shortcut <kbd>`ctrl/cmd`</kbd> + <kbd>`S`</kbd> to save the request to a collection.
3031

32+
::
3133
::
3234

3335
## Organizing collections

content/1.documentation/5.self-host/1.prerequisites.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -153,5 +153,9 @@ The links to configure OAuth for various providers are given below
153153
3. [**Microsoft**](https://learn.microsoft.com/en-us/azure/active-directory/develop/scenario-web-app-sign-user-app-registration?tabs=nodejs#register-an-app-by-using-the-azure-portal) (scope: user with read permission)
154154

155155
::alert{type="info"}
156-
It is recommended that you secure your deployments by issuing TLS certificates and using **HTTPS**, since we use **secure HTTP cookies** for authenticating users.
156+
::list{type="info"}
157+
158+
- It is recommended that you secure your deployments by issuing TLS certificates and using **HTTPS**, since we use **secure HTTP cookies** for authenticating users.
159+
160+
::
157161
::

content/1.documentation/5.self-host/2.install-and-build.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ title: Install and build
55
# Install and build
66

77
::alert{type="warning"}
8-
98
::list{type="warning"}
9+
1010
- In order for a smooth building process, it is recommended to have at least 16GB of RAM available in your system.
11+
1112
::
1213
::
1314

@@ -38,7 +39,7 @@ Copy the contents of `.env.example` file found in the root directory of cloned r
3839
```yaml
3940
#-----------------------Backend Config------------------------------#
4041
# Prisma Config
41-
DATABASE_URL=postgresql://postgres:testpass@hoppscotch-db:5432/hoppscotch # or replace with your database URL
42+
DATABASE_URL=postgresql://postgres:testpass@hoppscotch-db:5432/hoppscotch # or replace with your database URL
4243

4344
# Auth Tokens Config
4445
JWT_SECRET="secretcode123"
@@ -171,6 +172,9 @@ docker compose up hoppscotch-app # Runs the main frontend app up
171172

172173
Once everything is setup you can access:
173174

174-
Hoppscotch app at : `http://localhost:3000`
175+
::list{type="success"}
175176

176-
Hoppscotch admin dashboard at : `http://localhost:3100`
177+
- Hoppscotch app at: `http://localhost:3000`
178+
- Hoppscotch admin dashboard at: `http://localhost:3100`
179+
180+
::

content/1.documentation/7.contributors.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,9 @@ Here are some of our top contributors who helped us to make Hoppscotch a better
1111
![Contributors](https://contrib.rocks/image?repo=hoppscotch/hoppscotch)
1212

1313
::alert{type="info"}
14-
[View the full list of contributors here →](https://github.com/hoppscotch/hoppscotch/graphs/contributors)
14+
::list{type="info"}
15+
16+
- [View the full list of contributors here →](https://github.com/hoppscotch/hoppscotch/graphs/contributors)
17+
18+
::
1519
::

tokens.config.ts

+13-12
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,17 @@ import { defineTheme } from "pinceau"
33
export default defineTheme({
44
color: {
55
primary: {
6-
50: "#ecfdf5",
7-
100: "#d1fae5",
8-
200: "#a7f3d0",
9-
300: "#6ee7b7",
10-
400: "#34d399",
11-
500: "#10b981",
12-
600: "#059669",
13-
700: "#047857",
14-
800: "#065f46",
15-
900: "#064e3b",
16-
},
17-
},
6+
50: "#E3FDF4",
7+
100: "#C7FAE9",
8+
200: "#8EF5D3",
9+
300: "#56F0BD",
10+
400: "#1EECA7",
11+
500: "#10B981",
12+
600: "#0D9668",
13+
700: "#0A714E",
14+
800: "#064B34",
15+
900: "#03261A",
16+
950: "#02130D"
17+
}
18+
}
1819
})

0 commit comments

Comments
 (0)