mirror of
https://github.com/StarFleetCPTN/GoMFT.git
synced 2026-10-16 11:08:15 +02:00
feat: Integrate Docusaurus for documentation and enhance project structure
- Added Docusaurus configuration and initial setup for documentation. - Created multiple documentation pages covering installation, configuration, and core concepts. - Implemented a GitHub Actions workflow for automatic deployment of documentation to GitHub Pages. - Updated .gitignore to exclude Docusaurus build artifacts and dependencies. - Enhanced README with a link to the online documentation.
This commit is contained in:
1 parent
0aa68bc8e7
commit
834f066704
90 files changed
+24649
-15
No files matched your search
@@ -0,0 +1,47 @@
|
||||
# GoMFT Documentation
|
||||
|
||||
This repository contains the documentation for [GoMFT](https://github.com/StarFleetCPTN/GoMFT), a modern, web-based managed file transfer solution written in Go.
|
||||
|
||||
[](https://discord.gg/f9dwtM3j)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Start the development server
|
||||
npm run start
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
# Build the static site
|
||||
npm run build
|
||||
```
|
||||
|
||||
The built files will be in the `build` directory.
|
||||
|
||||
## Documentation Structure
|
||||
|
||||
- **Introduction**: Overview and features of GoMFT
|
||||
- **Getting Started**: Installation guides and quick start
|
||||
- **Core Concepts**: Detailed information about transfers, connections, and schedules
|
||||
- **Advanced Features**: Webhooks, email notifications, and admin tools
|
||||
- **Security**: Security best practices and configuration
|
||||
- **Development**: Project structure and contributing guidelines
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions to the documentation are welcome! Please submit a PR with your changes.
|
||||
|
||||
## Community
|
||||
|
||||
Join our [Discord community](https://discord.gg/f9dwtM3j) for support, discussions, and updates about GoMFT.
|
||||
|
||||
## License
|
||||
|
||||
This documentation is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
Reference in new issue
Block a user