You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
For developers interested in integrating with SmartSpawner, visit our [Developer API Documentation](https://nighterdevelopment.github.io/smartspawner-docs/developer-api/api-installation/) for installation instructions and documentation.
33
+
For developers interested in integrating with SmartSpawner, visit our [Developer API Documentation](https://nighterdevelopment.github.io/SmartSpawner/developer-api/api-installation/) for installation instructions and documentation.
Copy file name to clipboardExpand all lines: docs/README.md
+22-21Lines changed: 22 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,8 @@
7
7
8
8
This repository hosts the official documentation website for **[SmartSpawner](https://modrinth.com/plugin/smart-spawner-plugin)**, a powerful Minecraft plugin designed to enhance mob spawner management on servers.
9
9
10
+
> **Note:** The documentation source is located in the `docs/` folder of the main [SmartSpawner repository](https://github.com/NighterDevelopment/SmartSpawner).
11
+
10
12
## About SmartSpawner
11
13
12
14
SmartSpawner is a feature-rich plugin that simplifies and enhances the management of mob spawners in Minecraft servers. It offers advanced customization options, seamless integrations with popular plugins, and a robust developer API for extending functionality. Notably, its GUI-based system generates mob drops and experience without spawning entities, significantly boosting server performance.
@@ -31,8 +33,8 @@ SmartSpawner is a feature-rich plugin that simplifies and enhances the managemen
@@ -61,18 +63,21 @@ SmartSpawner is a feature-rich plugin that simplifies and enhances the managemen
61
63
## Project Structure
62
64
63
65
```
64
-
smartspawner-docs/
65
-
├── src/
66
-
│ ├── content/
67
-
│ │ ├── docs/ # Main documentation files (Markdown/MDX)
68
-
│ │ └── config.ts # Content configuration
69
-
│ ├── components/ # Custom Astro components
70
-
│ ├── styles/ # Custom CSS styles
71
-
│ └── assets/ # Static assets
72
-
├── public/ # Public static files
73
-
├── astro.config.mjs # Astro configuration
74
-
├── package.json # Project dependencies and scripts
75
-
└── tsconfig.json # TypeScript configuration
66
+
SmartSpawner/
67
+
├── docs/ # Documentation site (this folder)
68
+
│ ├── src/
69
+
│ │ ├── content/
70
+
│ │ │ └── docs/ # Main documentation files (Markdown/MDX)
71
+
│ │ ├── components/ # Custom Astro components
72
+
│ │ ├── styles/ # Custom CSS styles
73
+
│ │ └── assets/ # Static assets
74
+
│ ├── public/ # Public static files
75
+
│ ├── astro.config.mjs # Astro configuration
76
+
│ ├── package.json # Project dependencies and scripts
77
+
│ └── tsconfig.json # TypeScript configuration
78
+
├── core/ # Plugin core module
79
+
├── api/ # Plugin API module
80
+
└── ... # Other plugin source files
76
81
```
77
82
78
83
## Contributing
@@ -113,21 +118,17 @@ For significant changes or new features, please open an issue first to discuss t
113
118
114
119
## Deployment
115
120
116
-
This site is configured for deployment to GitHub Pages:
117
-
118
-
```bash
119
-
npm run deploy
120
-
```
121
+
The site is automatically deployed to GitHub Pages via GitHub Actions on every push to the `main` branch. The workflow is defined in `.github/workflows/deploy-docs.yml` at the root of the repository.
121
122
122
-
This command builds the site and deploys it using `gh-pages`.
123
+
The live site is available at: https://nighterdevelopment.github.io/SmartSpawner/
123
124
124
125
## License
125
126
126
127
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
127
128
128
129
## Support and Contact
129
130
130
-
-**Issues**: Report bugs or request features via [GitHub Issues](https://github.com/NighterDevelopment/smartspawner-docs/issues)
131
+
-**Issues**: Report bugs or request features via [GitHub Issues](https://github.com/NighterDevelopment/SmartSpawner/issues)
131
132
-**Discussions**: Join community discussions on [Discord Server](https://dsc.gg/nighterdevelopment)
132
133
133
134
For questions about the SmartSpawner plugin itself, please refer to the main plugin repository or community channels.
0 commit comments