New themes to Links Hub
The Project really requires Contributions! I would appreciate if you contribute.
Well apparently this guy swore to contribute, and I'm still waiting for that day.
We love your input! We want to make contributing to Links Hub as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Creating new themes
Getting Started
- Fork the repository on GitHub
- Clone your fork locally
git clone https://github.com/mudasarmajeed5/links-hub.git
- Create a new branch for your feature
git checkout -b feature/your-feature-name
Adding a New Theme
Themes in Links Hub are TypeScript objects that conform to the StyleConfig interface. To add a new theme:
- Navigate to
themes/themes.ts
- Add your theme object to the
themes array
- Ensure your theme implements all required properties from the
StyleConfig interface:
interface StyleConfig {
userTheme: number; // Unique theme identifier
styles: {
background: {
light: string; // Tailwind classes for light mode
dark: string; // Tailwind classes for dark mode
};
cards: {
light: string;
dark: string;
};
text: {
primary: {
light: string;
dark: string;
};
secondary: {
light: string;
dark: string;
};
};
};
animations: {
profileEntrance: string;
slideUp: string[];
};
components: {
// Component-specific styling
avatar: {
size: string;
border: string;
shadow: string;
hover: string;
};
// ... other component styles
};
star: {
enabled: boolean;
count: number;
animations: string[];
};
particles: {
enabled: boolean;
count: number;
animations: string[];
};
}
Theme Guidelines
- Use Tailwind CSS classes for styling
- Ensure both light and dark mode variants are provided
- Test your theme in both modes before submitting
- Follow the existing theme structure for consistency
Development Process
-
Install dependencies
-
Start the development server
-
Make your changes
-
Commit your changes with a descriptive message
git commit -m "Add feature: description of changes"
Submitting Changes
-
Push to your fork
git push origin feature/your-feature-name
-
Submit a Pull Request (PR)
- Go to your fork on GitHub
- Click "New Pull Request"
- Select your feature branch
- Fill out the PR template with:
Code Style
- Follow the existing code style
- Use TypeScript for type safety
- Write meaningful commit messages
Reporting Bugs
We use GitHub issues to track bugs. Report a bug by opening a new issue:
- Use a clear and descriptive title
- Describe the exact steps to reproduce the problem
- Provide specific examples if possible
- Describe the behavior you observed and what behavior you expected to see
- Include screenshots if possible
License
By contributing, you agree that your contributions will be licensed under the project's license.
Questions?
Feel free to open an issue for any questions about contributing!
New themes to Links Hub
The Project really requires Contributions! I would appreciate if you contribute.
Well apparently this guy swore to contribute, and I'm still waiting for that day.
We love your input! We want to make contributing to Links Hub as easy and transparent as possible, whether it's:
Getting Started
Adding a New Theme
Themes in Links Hub are TypeScript objects that conform to the
StyleConfiginterface. To add a new theme:themes/themes.tsthemesarrayStyleConfiginterface:Theme Guidelines
Development Process
Install dependencies
Start the development server
Make your changes
Commit your changes with a descriptive message
git commit -m "Add feature: description of changes"Submitting Changes
Push to your fork
Submit a Pull Request (PR)
Code Style
Reporting Bugs
We use GitHub issues to track bugs. Report a bug by opening a new issue:
License
By contributing, you agree that your contributions will be licensed under the project's license.
Questions?
Feel free to open an issue for any questions about contributing!