PathOfBuildingCommunity / PathOfBuildingCommunity/PathOfBuilding
Markdown support in Notes
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Lua
- Stars
- 5.4k
- Forks
- 2.4k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 26
Description
Check for duplicates
- I've checked for duplicate issues by using the search function of the issue tracker
Is your feature request related to a problem?
No
Describe the solution you'd like
Simple markdown rendering in build notes could allow for much "prettier" guides distributed with builds.
Ultimately you would probably need a button to toggle between edit/view mode for the notes now.
Describe alternatives you've considered
No response
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by locating the existing build-notes editor and its UI flow, then clarify the Markdown scope and edit/view behavior before implementation; done requires agreement on the supported formatting and a way to verify rendered notes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- desktop
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100