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

IoTempower markmap #145

Open
5 of 10 tasks
mbz4 opened this issue Sep 3, 2024 · 0 comments
Open
5 of 10 tasks

IoTempower markmap #145

mbz4 opened this issue Sep 3, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@mbz4
Copy link
Collaborator

mbz4 commented Sep 3, 2024

  • a simple interactive, comprehensive map of IoTempower might help guide development

  • looked for solutions

    • markmap seems to fit what we need:
  • mature, robust

  • works well with static sites (exports to HTML)

  • feature-rich yet simple concept

Basically we use markmap-lib to preprocess Markdown into structured data, then render the data into interactive SVG with markmap-view.

markmap docs

Markmap is a combination of Markdown and mindmap. It parses Markdown content and extracts its intrinsic hierarchical structure and renders an interactive mindmap, aka markmap.

Try the online demo here!

Image

TODO (draft markmap v0):

  • plot basic layout
  • test export
  • test integrating (link-up sphinx docs w/ exported markmap
  • test programmatic markmap generation (Python?)
  • host IoTempower docs on GitHub pages?
@mbz4 mbz4 converted this from a draft issue Sep 3, 2024
@mbz4 mbz4 self-assigned this Sep 3, 2024
@mbz4 mbz4 added the enhancement New feature or request label Sep 3, 2024
@mbz4 mbz4 moved this from Backlog 🔜 to In Progress 🏗️ in IoTempower Task Manager Sep 3, 2024
@mbz4 mbz4 changed the title iotempower markmap IoTempower markmap Sep 4, 2024
@mbz4 mbz4 moved this from In Progress 🏗️ to Todo 📝 in IoTempower Task Manager Dec 25, 2024
@mbz4 mbz4 moved this from Todo 📝 to Backlog 🔜 in IoTempower Task Manager Dec 25, 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
Status: Backlog 🔜
Development

No branches or pull requests

1 participant