Mixcore Documentation

This repository contains the documentation for Mixcore CMS, built with Docusaurus 3.

The live documentation is available at docs.mixcore.org.

Documentation Structure

The documentation is organized by persona to make it easier for different users to find information relevant to their needs:

• Content Editors: People who create and manage content
• Administrators: System administrators who set up and maintain Mixcore
• Developers: People who build applications and extend Mixcore
• Theme Designers: People who create and customize visual themes
• DevOps Engineers: People who deploy and maintain infrastructure

Local Development

Prerequisites

• Node.js version 18 or above
• npm or yarn

Installation

# Clone the repository
git clone https://github.com/mixcore/mix.core.git

# Navigate to the docs directory
cd mix.core/docs

# Install dependencies
npm install

Running Locally

# Start the development server
npm start

This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.

Build

# Generate static content
npm run build

This command generates static content into the build directory and can be served using any static hosting service.

Deployment

The documentation is automatically deployed to GitHub Pages when changes are pushed to the master branch.

Manual Deployment

If you need to deploy manually, you can use the provided script:

# Make the script executable if needed
chmod +x publish-gh-pages

# Run the deployment script
./publish-gh-pages

GitHub Actions

Deployment is automated using GitHub Actions. The workflow configuration is located in .github/workflows/deploy.yml.

Contributing

We welcome contributions to improve the documentation:

1. Fork the repository
2. Create a branch for your changes
3. Make your changes
4. Submit a pull request

Guidelines

• Use clear, concise language
• Provide examples where applicable
• Keep each document focused on a specific topic
• Follow the persona-based organization

License

This documentation is licensed under the same license as Mixcore itself.

Contact

For questions about the documentation, please:

• Open an issue on GitHub
• Join the Mixcore Discussions
• Email us at [email protected]