Skip to content

Commit ef190fa

Browse files
committed
feat(docs): restructure documentation with i18n support 🌐
- Add benchmark directory to ignore patterns in deno.json - Add bilingual documentation structure for English and Indonesian - Add context object documentation page - Add custom response documentation page - Add default error behavior documentation page - Add Mermaid plugin support for VitePress documentation - Add philosophy documentation page - Add routes configuration documentation page - Add WebSocket middleware implementation and export - Export WebSocket middleware from middleware index - Remove old documentation files from root directory - Restructure documentation home page with hero section and features - Update contributing section with detailed guidelines - Update error middleware to accept Context instead of Request - Update error middleware type definition to use Context - Update README description tagline - Update README with bilingual documentation links - Update VitePress config with i18n locales and custom theme - Update version to 0.6.0
1 parent 2812d25 commit ef190fa

82 files changed

Lines changed: 6813 additions & 3329 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 36 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Deserve [![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](LICENSE) [![Deno](https://img.shields.io/badge/Deno-2.5.4-blue)](https://deno.land) [![JSR](https://jsr.io/badges/@neabyte/deserve)](https://jsr.io/@neabyte/deserve)
22

3-
HTTP server with file-based routing for Deno that supports middleware and dynamic routing.
3+
Build HTTP server effortlessly with zero configuration for productivity.
44

55
## Installation
66

@@ -12,46 +12,58 @@ Add Deserve using the `deno add` command:
1212
deno add jsr:@neabyte/deserve
1313
```
1414

15-
Follow our [installing guide](https://docs-deserve.neabyte.com/getting-started/installation) for more information.
15+
Follow our [installing guide](https://docs-deserve.neabyte.com/en/getting-started/installation) for more information.
1616

1717
## Table of Contents
1818

1919
- **Getting Started**
20-
- [Installation](https://docs-deserve.neabyte.com/getting-started/installation) - Set up Deserve in your project
21-
- [Quick Start](https://docs-deserve.neabyte.com/getting-started/quick-start) - Create your first API in minutes
22-
- [Server Configuration](https://docs-deserve.neabyte.com/getting-started/server-configuration) - Server setup and shutdown
23-
- [Custom Configuration](https://docs-deserve.neabyte.com/getting-started/custom-configuration) - Configure router options
20+
- [Installation](https://docs-deserve.neabyte.com/en/getting-started/installation) - Set up Deserve in your project
21+
- [Quick Start](https://docs-deserve.neabyte.com/en/getting-started/quick-start) - Create your first API in minutes
22+
- [Server Configuration](https://docs-deserve.neabyte.com/en/getting-started/server-configuration) - Server setup and shutdown
23+
- [Routes Configuration](https://docs-deserve.neabyte.com/en/getting-started/routes-configuration) - Configure router options
2424

2525
- **Core Concepts**
26-
- [File-based Routing](https://docs-deserve.neabyte.com/core-concepts/file-based-routing) - How file structure becomes API endpoints
27-
- [Route Patterns](https://docs-deserve.neabyte.com/core-concepts/route-patterns) - Dynamic routes and parameter matching
28-
- [HTTP Methods](https://docs-deserve.neabyte.com/core-concepts/http-methods) - All supported HTTP methods
29-
- [Request Handling](https://docs-deserve.neabyte.com/core-concepts/request-handling) - Enhanced request object with automatic parsing
26+
- [Philosophy](https://docs-deserve.neabyte.com/en/core-concepts/philosophy) - Framework design principles
27+
- [File-based Routing](https://docs-deserve.neabyte.com/en/core-concepts/file-based-routing) - How file structure becomes API endpoints
28+
- [Route Patterns](https://docs-deserve.neabyte.com/en/core-concepts/route-patterns) - Dynamic routes and parameter matching
29+
- [Context Object](https://docs-deserve.neabyte.com/en/core-concepts/context-object) - Request context wrapper with convenient methods
30+
- [Request Handling](https://docs-deserve.neabyte.com/en/core-concepts/request-handling) - Enhanced request object with automatic parsing
3031

3132
- **Middleware**
32-
- [Global Middleware](https://docs-deserve.neabyte.com/middleware/global) - Cross-cutting functionality
33-
- [Route-Specific Middleware](https://docs-deserve.neabyte.com/middleware/route-specific) - Targeted middleware for specific routes
34-
- [CORS Middleware](https://docs-deserve.neabyte.com/middleware/cors) - Cross-origin request handling
35-
- [WebSocket Middleware](https://docs-deserve.neabyte.com/middleware/websocket) - Real-time WebSocket communication
33+
- [Global Middleware](https://docs-deserve.neabyte.com/en/middleware/global) - Cross-cutting functionality
34+
- [Route-Specific Middleware](https://docs-deserve.neabyte.com/en/middleware/route-specific) - Targeted middleware for specific routes
35+
- [CORS Middleware](https://docs-deserve.neabyte.com/en/middleware/cors) - Cross-origin request handling
36+
- [WebSocket Middleware](https://docs-deserve.neabyte.com/en/middleware/websocket) - Real-time bidirectional communication
3637

3738
- **Response Utilities**
38-
- [Data Downloads](https://docs-deserve.neabyte.com/response/data) - Download in-memory content
39-
- [File Downloads](https://docs-deserve.neabyte.com/response/file) - Download files from filesystem
40-
- [JSON Format](https://docs-deserve.neabyte.com/response/json) - Create JSON responses easily
41-
- [Text Format](https://docs-deserve.neabyte.com/response/text) - Plain text responses
42-
- [HTML Format](https://docs-deserve.neabyte.com/response/html) - HTML content responses
43-
- [Redirect](https://docs-deserve.neabyte.com/response/redirect) - Redirect responses
39+
- [JSON Format](https://docs-deserve.neabyte.com/en/response/json) - Create JSON responses easily
40+
- [Text Format](https://docs-deserve.neabyte.com/en/response/text) - Plain text responses
41+
- [HTML Format](https://docs-deserve.neabyte.com/en/response/html) - HTML content responses
42+
- [File Downloads](https://docs-deserve.neabyte.com/en/response/file) - Download files from filesystem
43+
- [Data Downloads](https://docs-deserve.neabyte.com/en/response/data) - Download in-memory content
44+
- [Redirects](https://docs-deserve.neabyte.com/en/response/redirect) - Redirect responses
45+
- [Custom Responses](https://docs-deserve.neabyte.com/en/response/custom) - Full control over response options
4446

4547
- **Static Files**
46-
- [Basic Static Serving](https://docs-deserve.neabyte.com/static-file/basic) - Serve static files from directories
47-
- [Multiple Directories](https://docs-deserve.neabyte.com/static-file/multiple) - Serve from multiple locations
48+
- [Basic Static Serving](https://docs-deserve.neabyte.com/en/static-file/basic) - Serve static files from directories
49+
- [Multiple Directories](https://docs-deserve.neabyte.com/en/static-file/multiple) - Serve from multiple locations
4850

4951
- **Error Handling**
50-
- [Object Details](https://docs-deserve.neabyte.com/error-handling/object-details) - Detailed error information
52+
- [Default Behavior](https://docs-deserve.neabyte.com/en/error-handling/default-behavior) - Automatic error handling
53+
- [Object Details](https://docs-deserve.neabyte.com/en/error-handling/object-details) - Detailed error information
5154

5255
## Contributing
5356

54-
Contributions are welcome! Please feel free to submit a [Pull Request](https://github.com/NeaByteLab/Deserve/pulls).
57+
**Help us make Deserve even simpler!** Every contribution helps make building APIs effortless.
58+
59+
### How to Contribute
60+
61+
- **Report Bugs** - Found something broken? Let us know via [GitHub Issues](https://github.com/NeaByteLab/Deserve/issues)
62+
- **Suggest Features** - Have an idea that aligns with our simplicity-first philosophy? [Create an issue](https://github.com/NeaByteLab/Deserve/issues/new)
63+
- **Fix & Improve** - Submit [Pull Requests](https://github.com/NeaByteLab/Deserve/pulls) for bug fixes, typos, or code improvements
64+
- **Build Middleware** - Create and share third-party middleware that extends Deserve's capabilities
65+
- **Improve Docs** - Help us make the documentation clearer (supports English and Indonesian!)
66+
- **Use Deserve** - The best contribution? Use it in your projects and share your feedback
5567

5668
## License
5769

deno.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@neabyte/deserve",
33
"description": "HTTP server with file-based routing library for Deno",
4-
"version": "0.5.0",
4+
"version": "0.6.0",
55
"type": "module",
66
"license": "MIT",
77
"exports": "./src/index.ts",
@@ -95,6 +95,7 @@
9595
"*.spec.ts",
9696
"*.test.ts",
9797
".github/",
98+
"benchmark/",
9899
"coverage/",
99100
"deno.json",
100101
"docs/",

0 commit comments

Comments
 (0)