Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: Set Up Markdown Parsing for CV #3

Open
1 task done
Colin23 opened this issue Dec 30, 2024 · 0 comments
Open
1 task done

[Feature]: Set Up Markdown Parsing for CV #3

Colin23 opened this issue Dec 30, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Colin23
Copy link
Owner

Colin23 commented Dec 30, 2024

🌟 Situation

The project requires a way to manage and display CV content dynamically. Storing the CV in a Markdown file allows for simple and flexible editing, but a mechanism is needed to parse and render this content into HTML for display on the website.

🎯 Task

Integrate Marked.js to parse the CV content stored in a Markdown file and render it dynamically on the portfolio website.

🛠️ Action

  1. Install Marked.js as a dependency
    • Run pnpm add marked.
  2. Create a Markdown file (e.g., cv.md) to store CV content in a structured format.
  3. Write a SvelteKit component (e.g., Cv.svelte) to
    • Read the cv.md file.
    • Use Marked.js to parse the Markdown content into HTML.
    • Render the HTML within the component.
  4. Ensure proper styling of the parsed Markdown using Tailwind CSS.
  5. (Optional) Add error handling for cases where the Markdown file is missing or improperly formatted.

🏆 Result

The CV content stored in the Markdown file will be dynamically parsed and rendered on the website. This approach ensures easy content updates without modifying the codebase and keeps the CV content in a readable, structured format.

🙋‍♀️ Are you willing to contribute to this feature?

Yes, I'm ready to contribute!

📝 Code of Conduct

  • I agree to follow this project's Code of Conduct
@Colin23 Colin23 added the enhancement New feature or request label Dec 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant