1
$\begingroup$

I am currently writing a Mathematica package containing several functions I developed in the last few years to perform computations in quantum physics. I am planning to put a preliminary version of the code on GitHub very soon, such that people who are potentially interested in can give me feedbacks and so on.

To make the package easier to handle, I am also writing a notebook which can be used as a tutorial to learn the various functions of the package.

Is there a way to improve the way GitHub format the notebook? Something like the results you can get when you upload a Jupyter notebook. As far as I can understand, GitHub converts the Mathematica files into raw code: this is of course fine for the package, but it's not good for the notebook.

$\endgroup$
6
  • $\begingroup$ In short, no. Please search this site. The topic has been discussed quite a few times before. Consider packagedata.net instead. $\endgroup$
    – MarcoB
    Jun 13, 2020 at 4:47
  • 1
    $\begingroup$ Take a look at [136634) and (26174). $\endgroup$
    – MarcoB
    Jun 13, 2020 at 4:49
  • 1
    $\begingroup$ Thank you, @MarcoB. I tried to ask again to check if something new came out more recently. $\endgroup$
    – Dario Rosa
    Jun 13, 2020 at 5:14
  • 1
    $\begingroup$ As an alternative to putting your tutorial on GitHub, you could put it on Wolfram Cloud. See Q&A about exporting Workbench-made docs here and example here. $\endgroup$
    – Chris K
    Jun 13, 2020 at 13:59
  • 1
    $\begingroup$ github.com/cklausme/EcoEvo/blob/master/finish%20paclet.wl has various hacks I put together with help from folks around here for finishing a paclet after building the docs with Workbench. You might find it useful. $\endgroup$
    – Chris K
    Jun 13, 2020 at 15:12

0

Browse other questions tagged or ask your own question.