Skip to content
/ md2fig Public

md2fig = Markdown to Figma: A Figma plugin for a markdown resume in Figma (.md to .fig)

Notifications You must be signed in to change notification settings

t1c1/md2fig

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown to Figma - Classic Resume Figma Plugin

Plugin Icon

A Figma plugin that transforms Markdown-formatted text into a professionally designed classic resume. Perfect for designers and professionals looking to create sleek resumes effortlessly.

🚀 Features

  • Markdown Support: Convert Markdown text into structured resume sections.
  • Formatted Text: Supports bold text and hyperlinks.
  • Auto Pagination: Automatically creates new pages if content exceeds page height.
  • Customizable Layout: Adjust page dimensions, margins, and spacing as needed.
  • Responsive Design: Ensures your resume looks great on various devices and formats.
  • Easy Editing: Modify generated resumes directly within Figma for further customization.

📦 Installation

  1. Clone the Repository:

    git clone https://github.com/t1c1/md2fig.git
  2. Load into Figma:

    • Open Figma.
    • Navigate to Plugins > Development > Import Plugin from Manifest...
    • Select the manifest.json file from the cloned repository.

🛠️ Usage

  1. Open the Plugin In Figma, go to Plugins > Development > Classic Resume.

  2. Input Markdown Paste your Markdown-formatted resume into the textarea.

    Example:

    # John Doe
    ## Professional Summary
    Experienced software engineer with a passion for developing innovative programs.
    
    ## Work Experience
    ### Senior Developer, Tech Co
    - Led a team of 5 developers
    - Implemented new features for the main product
    
    ## Education
    ### Bachelor of Science in Computer Science
    University of Example, 2015-2019
    
    ## Skills
    - JavaScript
    - Python
    - React
  3. Generate Resume Click the "Create Resume" button. The plugin will generate formatted text nodes within Figma, creating new pages as necessary.

🌟 Getting Started

Follow these steps to get your Classic Resume plugin up and running:

  1. Ensure You Have Figma Installed:

    • Download Figma if you haven't already.
  2. Clone and Load the Plugin:

    • Clone the repository as shown in the Installation section.
    • Import the plugin into Figma.
  3. Prepare Your Markdown Resume:

    • Use any Markdown editor or write directly in a text editor.
  4. Generate and Customize:

    • Use the plugin to generate your resume.
    • Edit and customize the design directly within Figma as needed.

🐞 Troubleshooting

Q1: The plugin isn't generating the resume correctly. What should I do?

A: Ensure your Markdown syntax is correct. Refer to the Markdown Guide for proper formatting. If the issue persists, open an issue on GitHub with detailed information.

Q2: I'm experiencing performance issues when generating large resumes.

A: Try breaking down your resume into smaller sections or optimizing the content. If the problem continues, please report it here.

Q3: How do I update the plugin after making changes?

A: After pulling the latest changes from the repository, re-import the plugin in Figma by navigating to Plugins > Development > Import Plugin from Manifest... and selecting the updated manifest.json file.

📝 Contributing

Contributions are welcome! Please follow these guidelines:

  1. Fork the Repository:

    • Click the "Fork" button at the top-right corner of the repository page.
  2. Create a Feature Branch:

    git checkout -b feature/YourFeatureName
  3. Commit Your Changes:

    git commit -m "Add a new feature"
  4. Push to the Branch:

    git push origin feature/YourFeatureName
  5. Open a Pull Request:

    • Navigate to your forked repository on GitHub.
    • Click "Compare & pull request".
    • Provide a clear description of your changes and submit the pull request.

📞 Contact

For any questions, feedback, or support, please open an issue on GitHub or contact me directly at [email protected].

🔗 Useful Links

📝 Changelog

v1.0.0 - 2024-10-08

  • Initial release of Classic Resume plugin.
  • Supports Markdown conversion to resume sections.
  • Features auto pagination and customizable layout.

📈 Roadmap (2025)

  • Export Options: Allow exporting resumes in PDF or DOCX formats.
  • Templates: Introduce multiple resume templates for varied styles.
  • Collaboration Features: Enable sharing and collaborative editing of resumes.
  • Integration with LinkedIn: Import professional data directly from LinkedIn profiles.

❓ FAQ

Q: Can I customize the colors and fonts used in the generated resume?
A: Yes! After generating the resume, you can modify colors, fonts, and other design elements directly within Figma.

Q: Does the plugin support images in the resume?
A: Currently, the plugin focuses on text formatting. Future updates may include support for images.

Q: Is there a way to import existing Figma resumes and convert them to Markdown?
A: This feature is not available at the moment but is on our roadmap for future releases.

🆘 Support

If you encounter any issues or have questions about using the Classic Resume plugin, please:

  1. Check Existing Issues: Browse through existing issues on GitHub to see if your question has already been answered.
  2. Open a New Issue: If you can't find a solution, feel free to open a new issue detailing your problem.
  3. Contact Directly: For urgent support, email me at [email protected].

🙏 Acknowledgments

  • Figma for providing an excellent design platform.
  • Markdown Guide for comprehensive Markdown resources.
  • GitHub for hosting and version control.

About

md2fig = Markdown to Figma: A Figma plugin for a markdown resume in Figma (.md to .fig)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published