Skip to content

Customization

b3m2a1 edited this page Jun 6, 2018 · 2 revisions

Via PacletInfo.m

The first simple customization you can provide is simply a change to the "PacletInfo.m" file of your package. Any valid parameters you use there will make their way onto the paclet page. Some good examples of these files may be found here or here .

On top of this you can add information via the custom "PacletServer" extension. Here's an example of the things that can be added to this extension:

{
    "PacletServer",
    "Tags" -> { "tag1", "tag2", ...},
    "Categories" -> {"Category1", "Category2", ...},
    "Description" -> "Long-form description for the page",
    "License" -> "YourLicense"
  }

The "Tags" and "Categories" will go into the search functionality and the "License" will display on your page. On top of this any standard parameter (like the "Description" ) that you put here will be used instead of the default when building the page. This can help if you'd like to be more verbose on the paclet shingle than in the results from PacletInformation .

Via Markdown Notebook

Customizations can be done to the Markdown notebook from which the .md file is generated. An example of one of these notebooks is here .

Most features that can be implemented in Markdown are implemented for these notebooks, including export of "Text" , "Code" , "Output" , "Section" , "Subsection" , "Subsubsection" and a number of custom styled cells.

More info can be provided if desired

Custom Pages and Themes

You can also add custom pages to the server in the "content/pages" folder. Add these as either raw HTML or Markdown and they'll be built in. Similarly theme changes may be added to the files in the "theme" folder.

Clone this wiki locally