Skip to content

feat: add ignore dead links configuration and update documentation links #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 4, 2025
Merged

feat: add ignore dead links configuration and update documentation links #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2341150
feat: add ignore dead links configuration and update documentation links
dacsang97 Oct 4, 2025
ef11d23
feat: set base path for nginx-love documentation
dacsang97 Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions apps/docs/.vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ export default defineConfig({
title: 'nginx-love Documentation',
description: 'Enterprise Nginx + ModSecurity Management Platform',
lang: 'en-US',
base: '/nginx-love/',

// Theme appearance
appearance: 'dark',
Expand Down Expand Up @@ -202,6 +203,12 @@ export default defineConfig({
}
},

// Ignore dead links configuration
ignoreDeadLinks: [
/^http:\/\/localhost/,
/^http:\/\/YOUR_IP/
Copy link

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The regex pattern /^http:\/\/YOUR_IP/ uses a placeholder 'YOUR_IP' which may not match actual IP addresses. Consider using a more specific pattern like /^http:\/\/\d+\.\d+\.\d+\.\d+/ for IPv4 addresses or document that 'YOUR_IP' should be replaced with actual values.

Suggested change
/^http:\/\/YOUR_IP/
/^http:\/\/\d+\.\d+\.\d+\.\d+/

Copilot uses AI. Check for mistakes.
],

// Markdown configuration
markdown: {
theme: {
Expand Down
3 changes: 1 addition & 2 deletions apps/docs/guide/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,4 @@ nginx-love collects and displays performance metrics for your Nginx servers, hel
## Next Steps

- [Installation Guide](/guide/installation) - Learn how to install nginx-love
- [Quick Start](/guide/quick-start) - Get up and running quickly
- [Features](/guide/features) - Explore all available features
- [Quick Start](/guide/quick-start) - Get up and running quickly
4 changes: 2 additions & 2 deletions apps/docs/guide/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ Congratulations! You've successfully set up your first domain with the Nginx WAF
- [**ModSecurity Rules**](/guide/modsecurity): Create custom WAF rules
- [**Performance Optimization**](/guide/performance): Advanced monitoring and optimization
- [**Log Analysis**](/guide/logs): Deep dive into log analysis and troubleshooting
- [**API Integration**](/api/): Integrate with external systems via REST API
- [**API Integration**](/api/auth): Integrate with external systems via REST API

### Maintenance and Monitoring

Expand All @@ -405,7 +405,7 @@ If you encounter any issues or have questions:

- Check our [troubleshooting guide](/reference/troubleshooting)
- Review the [FAQ](/reference/faq)
- Browse our [API documentation](/api/)
- Browse our [API documentation](/api/auth)
- Contact support for assistance

## Installation Complete
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ To get started with nginx-love, follow our [installation guide](/guide/installat

## Documentation

- [Guide](/guide/) - Learn how to use nginx-love
- [API Reference](/api/) - Explore the REST API
- [Reference](/reference/) - Find configuration options and troubleshooting tips
- [Guide](/guide/introduction) - Learn how to use nginx-love
- [API Reference](/api/auth) - Explore the REST API
- [Reference](/reference/configuration) - Find configuration options and troubleshooting tips
3 changes: 2 additions & 1 deletion apps/docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@
"vue": "^3.3.4"
},
"devDependencies": {
"vitepress": "^2.0.0-alpha.12",
"terser": "^5.44.0",
"typescript": "^5.2.2",
"vitepress": "^2.0.0-alpha.12",
"vue-tsc": "^1.8.8"
}
}
84 changes: 80 additions & 4 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.