M3U Editor Documentation

Official documentation for M3U Editor - A full-featured IPTV playlist manager.

Built with Docusaurus.

🚀 Quick Start

Installation

npm install

Local Development

npm start

This starts a local development server and opens a browser window. Most changes are reflected live without restarting.

Build

npm run build

Generates static content into the build directory for deployment.

🛠️ Configuration

Site Configuration

Edit docusaurus.config.js:

const config = {
  title: 'M3U Editor',
  tagline: 'Your tagline here',
  url: 'https://your-domain.com',
  baseUrl: '/',
  organizationName: 'your-github-username',
  projectName: 'your-repo-name',
  // ...
};

Sidebar Configuration

Edit sidebars.js to customize the documentation sidebar:

const sidebars = {
  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
};

📝 Contributing

Adding New Documentation

1. Create a new markdown file in the appropriate directory:

   docs/advanced/new-feature.md

2. Add frontmatter:

   ---
   sidebar_position: 3
   description: Description of this page
   tags:
     - Advanced
     - Feature
   title: New Feature
   ---
   
   # New Feature
   
   Your content here...

3. Preview locally:

   npm start

Adding Images

Place images in static/img/:

![Alt text](/img/screenshots/your-image.png)

Code Blocks

Use syntax highlighting:

```bash
docker-compose up -d
```

```javascript
const config = {
  // your config
};
```

🎨 Customization

Custom CSS

Edit src/css/custom.css for custom styles:

:root {
  --ifm-color-primary: #your-color;
}

Custom Components

Create React components in src/components/:

// src/components/MyComponent.jsx
export default function MyComponent() {
  return <div>Custom component</div>;
}

Use in markdown:

import MyComponent from '@site/src/components/MyComponent';

<MyComponent />

📦 Dependencies

Key dependencies:

• Docusaurus: Static site generator
• React: UI framework
• MDX: Markdown with JSX support

🔧 Troubleshooting

Build Errors

Clear cache and rebuild:

npm run clear
npm run build

Port Already in Use

Change the port:

npm start -- --port 3001

Broken Links

Check for broken links:

npm run build

Docusaurus will fail the build if there are broken links (configured with onBrokenLinks: 'throw').

📄 License

Documentation licensed under CC BY-NC-SA 4.0.

M3U Editor is licensed under CC BY-NC-SA 4.0.

🔗 Links

• Main Project: https://github.com/sparkison/m3u-editor
• Documentation: https://sparkison.github.io/m3u-editor-docs-v2/
• Discord: https://discord.gg/rS3abJ5dz7
• Issues: https://github.com/sparkison/m3u-editor/issues

💬 Support

• Join our Discord for help and discussions
• Report documentation issues in this repository
• Report M3U Editor bugs in the main repository