Skip to content

Commit 6c509ae

Browse files
committed
Update Node.js version to 20 in GitHub Actions workflow and clean up package-lock.json
1 parent 6218d72 commit 6c509ae

File tree

3 files changed

+14
-456
lines changed

3 files changed

+14
-456
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
fetch-depth: 0
2626
- uses: actions/setup-node@v4
2727
with:
28-
node-version: 18
28+
node-version: 20
2929
cache: npm
3030

3131
- name: Install dependencies

README.md

Lines changed: 5 additions & 179 deletions
Original file line numberDiff line numberDiff line change
@@ -1,190 +1,16 @@
11
# InterceptSuite Documentation
22

3-
This is the official documentation website for [InterceptSuite](https://github.com/your-username/InterceptSuite), an advanced network interception and analysis suite.
3+
Official documentation site for InterceptSuite - Advanced Network Interception and Analysis Suite.
44

5-
The website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
5+
Built with [Docusaurus](https://docusaurus.io/).
66

7-
## 🚀 Quick Start
8-
9-
### Prerequisites
10-
11-
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above
12-
- npm or yarn package manager
13-
14-
### Installation
7+
## Development
158

169
```bash
1710
npm install
18-
```
19-
20-
### Local Development
21-
22-
```bash
2311
npm start
2412
```
2513

26-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
27-
28-
The site will be available at `http://localhost:3000`.
29-
30-
## 🔧 Building
31-
32-
```bash
33-
npm run build
34-
```
35-
36-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
37-
38-
## 🚀 Deployment
39-
40-
This documentation site is automatically deployed to GitHub Pages using GitHub Actions when changes are pushed to the main branch.
41-
42-
### Manual Deployment
43-
44-
If you need to deploy manually:
45-
46-
```bash
47-
# Build the site
48-
npm run build
49-
50-
# Deploy to GitHub Pages (if you have permissions)
51-
npm run deploy
52-
```
53-
54-
### GitHub Pages Configuration
55-
56-
The site is configured to deploy to GitHub Pages with:
57-
58-
- **Source**: GitHub Actions
59-
- **Custom domain**: (configure in repository settings if needed)
60-
- **Base URL**: `/InterceptSuite/` (adjust in `docusaurus.config.ts` if different)
61-
62-
## 📝 Contributing to Documentation
63-
64-
### Adding New Documentation
65-
66-
1. **Create new markdown files** in the `docs/` directory
67-
2. **Update sidebars** in `sidebars.ts` if needed
68-
3. **Add to navigation** by updating the appropriate category
69-
70-
### Directory Structure
71-
72-
```
73-
docs/
74-
├── intro.md # Getting started
75-
├── installation.md # Installation guide
76-
├── configuration.md # Configuration
77-
├── user-guide/ # User guides
78-
│ └── quick-start.md
79-
├── api/ # API documentation
80-
│ └── overview.md
81-
└── examples/ # Examples and tutorials
82-
└── http-traffic-analysis.md
83-
```
84-
85-
### Writing Guidelines
86-
87-
- Use clear, concise language
88-
- Include code examples where appropriate
89-
- Add screenshots for UI-related documentation
90-
- Follow the existing style and structure
91-
- Test all code examples before submitting
92-
93-
### Blog Posts
94-
95-
Add blog posts to the `blog/` directory:
96-
97-
```markdown
98-
---
99-
title: "New Feature Announcement"
100-
description: "Announcing exciting new features in InterceptSuite"
101-
slug: new-features-v2
102-
authors: [your-username]
103-
tags: [announcement, features]
104-
---
105-
106-
Your blog post content here...
107-
```
108-
109-
## 🛠️ Customization
110-
111-
### Configuration
112-
113-
Main configuration is in `docusaurus.config.ts`:
114-
115-
- **Site metadata** (title, description, URL)
116-
- **GitHub Pages settings** (organizationName, projectName)
117-
- **Theme configuration** (navbar, footer, colors)
118-
- **Plugin configuration** (search, analytics, etc.)
119-
120-
### Styling
121-
122-
- **Global styles**: `src/css/custom.css`
123-
- **Component styles**: `src/components/*/styles.module.css`
124-
- **Theme customization**: See [Docusaurus theming docs](https://docusaurus.io/docs/styling-layout)
125-
126-
### Custom Components
127-
128-
Add custom React components in `src/components/`:
129-
130-
```tsx
131-
// src/components/CustomComponent/index.tsx
132-
import React from 'react';
133-
import styles from './styles.module.css';
134-
135-
export default function CustomComponent(): JSX.Element {
136-
return (
137-
<div className={styles.customComponent}>
138-
<h2>Custom Component</h2>
139-
</div>
140-
);
141-
}
142-
```
143-
144-
## 🔍 Search
145-
146-
Search is powered by Algolia DocSearch. Configuration is in `docusaurus.config.ts`.
147-
148-
## 📊 Analytics
149-
150-
Analytics can be configured in `docusaurus.config.ts`:
151-
152-
```javascript
153-
// Google Analytics
154-
gtag: {
155-
trackingID: 'G-XXXXXXXXXX',
156-
anonymizeIP: true,
157-
},
158-
```
159-
160-
## 🐛 Troubleshooting
161-
162-
### Common Issues
163-
164-
**Build Failures**
165-
- Check Node.js version (18.0+ required)
166-
- Clear cache: `npm run clear`
167-
- Delete `node_modules` and reinstall
168-
169-
**GitHub Pages Deployment Issues**
170-
- Verify repository settings
171-
- Check GitHub Actions workflow logs
172-
- Ensure base URL matches repository name
173-
174-
**Local Development Issues**
175-
- Port conflicts: Use `npm start -- --port 3001`
176-
- Cache issues: Use `npm run clear`
177-
178-
### Getting Help
179-
180-
- [Docusaurus Documentation](https://docusaurus.io/docs)
181-
- [InterceptSuite GitHub Issues](https://github.com/your-username/InterceptSuite/issues)
182-
- [Docusaurus Discord](https://discordapp.com/invite/docusaurus)
183-
184-
## 📄 License
185-
186-
This documentation is part of the InterceptSuite project and follows the same license terms.
187-
188-
---
14+
## Deployment
18915

190-
**Note**: Remember to replace `your-username` with your actual GitHub username in the configuration files and URLs throughout the documentation.
16+
Automatically deployed to GitHub Pages via GitHub Actions.

0 commit comments

Comments
 (0)