Skip to content

Commit c4c296a

Browse files
LinuxDevilLinuxDevil
committed
feat: add docs for mcp-generator
0 parents  commit c4c296a

Some content is hidden

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

47 files changed

+21232
-0
lines changed

‎.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 LinuxDevil
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
# MCP Server Generator Documentation
2+
3+
This is the official documentation website for **MCP Server Generator**, a modern CLI tool for generating and extending production-ready Model Context Protocol (MCP) servers.
4+
5+
🌐 **Live Documentation**: [mcp-server-generator.com](https://mcp-server-generator.com)
6+
7+
## About
8+
9+
This documentation site provides comprehensive guides, examples, and API references for:
10+
11+
- **🚀 Project Generation** - Creating new MCP servers with comprehensive features
12+
- **➕ Component Extension** - Adding tools, resources, prompts, services, transports, and utilities
13+
- **📚 Developer Guides** - Installation, CLI commands, and best practices
14+
- **🔧 API Reference** - Complete technical documentation
15+
- **💡 Examples** - Real-world use cases and implementation patterns
16+
17+
## Built With
18+
19+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator that provides:
20+
21+
- **📱 Responsive Design** - Works on all devices
22+
- **🌙 Dark/Light Mode** - Theme switching support
23+
- **🔍 Built-in Search** - Fast content discovery
24+
- **📖 Versioning** - Multiple documentation versions
25+
- **🌐 Internationalization** - Multi-language support
26+
27+
## Development
28+
29+
### Prerequisites
30+
31+
- **Node.js 18+** - [Download from nodejs.org](https://nodejs.org/)
32+
- **npm** or **yarn** - Package manager
33+
34+
### Installation
35+
36+
```bash
37+
# Clone the repository
38+
git clone https://github.com/LinuxDevil/Create-MCP.git
39+
cd Create-MCP/docs
40+
41+
# Install dependencies
42+
npm install
43+
# or
44+
yarn install
45+
```
46+
47+
### Local Development
48+
49+
```bash
50+
# Start development server
51+
npm start
52+
# or
53+
yarn start
54+
```
55+
56+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
57+
58+
**Local URL**: http://localhost:3000
59+
60+
### Build
61+
62+
```bash
63+
# Generate static content
64+
npm run build
65+
# or
66+
yarn build
67+
```
68+
69+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
70+
71+
### Deployment
72+
73+
#### GitHub Pages
74+
75+
```bash
76+
# Using SSH
77+
USE_SSH=true npm run deploy
78+
# or
79+
USE_SSH=true yarn deploy
80+
81+
# Using HTTPS
82+
GIT_USER=<Your GitHub username> npm run deploy
83+
# or
84+
GIT_USER=<Your GitHub username> yarn deploy
85+
```
86+
87+
#### Other Hosting Services
88+
89+
The `build` directory can be deployed to:
90+
- **Vercel** - `vercel --prod`
91+
- **Netlify** - Drag and drop `build` folder
92+
- **AWS S3** - Upload `build` contents
93+
- **Cloudflare Pages** - Connect GitHub repository
94+
95+
## Documentation Structure
96+
97+
```
98+
docs/
99+
├── intro.md # Getting started
100+
├── installation.md # Installation guide
101+
├── cli-commands.md # CLI reference
102+
├── examples.md # Usage examples
103+
├── components/ # Component guides
104+
│ └── overview.md # Component overview
105+
├── api/ # API reference
106+
│ └── overview.md # API documentation
107+
blog/ # Blog posts
108+
├── authors.yml # Author information
109+
└── 2025-09-25-component-extension-release.md
110+
```
111+
112+
## Contributing to Documentation
113+
114+
We welcome contributions to improve the documentation:
115+
116+
### Content Updates
117+
118+
1. **Fork** the repository
119+
2. **Create** a feature branch: `git checkout -b docs/improve-examples`
120+
3. **Edit** markdown files in the `docs/` directory
121+
4. **Test** locally: `npm start`
122+
5. **Commit** changes: `git commit -m 'Improve examples documentation'`
123+
6. **Push** to branch: `git push origin docs/improve-examples`
124+
7. **Open** a Pull Request
125+
126+
### Adding New Pages
127+
128+
1. **Create** new `.md` file in appropriate directory
129+
2. **Update** `sidebars.ts` to include the new page
130+
3. **Add** internal links from related pages
131+
4. **Test** navigation and links locally
132+
133+
### Blog Posts
134+
135+
1. **Create** new file: `blog/YYYY-MM-DD-post-title.md`
136+
2. **Add** frontmatter with title, authors, tags
137+
3. **Write** content with code examples
138+
4. **Update** `authors.yml` if adding new author
139+
140+
### Style Guide
141+
142+
- **Use** clear, concise language
143+
- **Include** code examples for technical concepts
144+
- **Add** emojis for visual appeal (sparingly)
145+
- **Structure** content with proper headings
146+
- **Link** to related documentation
147+
148+
## Links
149+
150+
- **🏠 Homepage**: [mcp-server-generator.com](https://mcp-server-generator.com)
151+
- **📦 NPM Package**: [mcp-server-generator](https://www.npmjs.com/package/mcp-server-generator)
152+
- **🐙 GitHub Repository**: [LinuxDevil/Create-MCP](https://github.com/LinuxDevil/Create-MCP)
153+
- **🐛 Issues**: [GitHub Issues](https://github.com/LinuxDevil/Create-MCP/issues)
154+
- **💬 Discussions**: [GitHub Discussions](https://github.com/LinuxDevil/Create-MCP/discussions)
155+
- **🌐 MCP Protocol**: [modelcontextprotocol.io](https://modelcontextprotocol.io)
156+
157+
## License
158+
159+
This documentation is part of the MCP Server Generator project and is licensed under the MIT License. See the [LICENSE](../LICENSE) file for details.

0 commit comments

Comments
 (0)