Group Abstract Group Abstract

Message Boards Message Boards

0
|
328 Views
|
3 Replies
|
2 Total Likes
View groups...
Share
Share this post:
GROUPS:
Packages

Paclet symbol documentation: convert from Markdown to notebook

Naman Taggar
Posted 13 days ago

Hi, I came across this paclet whose documentation on its github repository is in markdown format. I think that's great, makes it easy to collaborate on documentation creation. But how does this work, how may I write my documentation in markdown format for mathematica to convert it into notebooks while build process? Is that a thing? Thanks!

https://github.com/WolframInstitute/Hypergraph/tree/main/docs/Symbols
POSTED BY: Naman Taggar
3 Replies
Sort By:

This is the answer: https://github.com/WolframInstitute/MarkdownToNotebook
POSTED BY: Mohammad Bahrami

Hi Naman,

If you have a MD file, you can open it using Mathematica using the tab File --> Open...
In the file extension drop menu, you can look for Markdown enter image description here

This should open a notebook version of the MD file.
Does this answer's your question? Let me know how it goes please.
POSTED BY: Ahmed Elbanna
Naman Taggar
Naman Taggar
Posted 10 days ago

Hi Ahmed, thanks for replying! Yes, that works. I didnt know we could do that... I also realised the repository I linked in my post has a buildDoc.wl script to build documentation from .md files. I also stumbled across a WFR resource which converts .md to .nb files. Had made an edit to the post, it seems that didn't go through. Thanks a lot and have a great day!
POSTED BY: Naman Taggar
Reply to this discussion
Community posts can be styled and formatted using the Markdown syntax.
Tag limit exceeded
Note: Only the first five people you tag will receive an email notification; the other tagged names will appear as links to their profiles.
Reply Preview
Attachments
Remove
or Discard