On generating output files,
Came across this error when publish.js tries copying files,

'/home/akshitgrover/projects/express/alterset/node_modules/minami/static/fonts/OpenSans-Bold-webfont.eot' -> 'docs/alterset/1.0.0/fonts
I fixed this issue, Should I open a pull request for the same?

Hi,

Your theme is quite interesting. I have tried to generate with my Rest API. However, as you mentioned it hasn't completed yes. Please finish API part.
Thanks,
Trung.

Mixed Content: The page at 'index.html' was loaded over HTTPS, but requested an insecure stylesheet 'http://fonts.googleapis.com/css?family=Montserrat:400,700'. This request has been blocked; the content must be served over HTTPS.

Because in repo stylesheet is linked by https. In npm package stylesheet is linked by http.

Thank's.

No idea why it happens, but it appears to happen with every method. Both duplicates are the same, except that one has the correct example, while one has the example from the previous method.

Without padding on the bottom of the nav element, the lower-left URL preview displayed by most browsers obfuscates the bottom element:

This can be prevented by adding:

nav {
    ...
    padding-bottom: 20px;
}

I create an new tag ..

exports.defineTags = function (dictionary) {
  dictionary.defineTag("topic", {
    mustHaveValue: true,
    canHaveType: false,
    canHaveName: true,
    onTagged: function (doclet, tag) {
      doclet.topic = tag.value;
    }
  });
};

Inclide in my jsdoc.json ..

{
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc"]
  },
  "source": {
    "include": ["package.json", "README.md"],
    "includePattern": ".js$",
    "excludePattern": "(node_modules/|docs)"
  },
  "plugins": [
    "plugins/markdown",
    "./jsdoc/topic.js" // HERE
  ],
  "opts": {
    "template": "./node_modules/minami",
    "encoding": "utf8",
    "destination": "docs/",
    "recurse": true,
    "verbose": true
  },
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": true,
    "useLongnameInNav": false,
    "showInheritedInNav": true
  }
}

Added into my code

• @topic to/robot/{MAC_ADDRESS}

But nothing change in doc

I get this error when trying to build. I followed the instructions in the readme, and initially everything worked as expected. I don't know what changed that could be causing this error. Looking at the package.json, I don't see any dependencies declared, so it makes sense that this error would happen here. This also means that I don't know why this template worked in the first place.

If you have an @example tag, it gets grouped with the wrong method because the horizontal rule comes before it, rather than after.

This was added in jsdoc 3.5.0 jsdoc/jsdoc#952

thanks!

Great theme you've made here!

Any change there will be support for @modules or @packages? Where each package have it's own classes?

I'm working on a meteor project, and it would be really great if I could use this theme for it's documentation. Meteor packages are comparable to node_modules. Lets for example say you've got two packages, and both package have a object called "Config". You'll definately wish to keep them separate in the documentation.

Like (sidebar visualisation):

CLASSES
  myClass      # class
    initialize # method

PACKAGES
  cars         # package
    config     # class
      get      # method
  boats        # package
    config     # class
      get      # method

GLOBALS
  myGlobal     # global

When I try to npm install the package I get the following error:

Could not install from "minami" as it does not contain a package.json file.

Hi this template is really beautiful, but I would like it to output a markdown file instead of a html one.
Do you know how can I do it?

Hi,
I've noticed that when documenting a class with jsdoc using minami as template, there is two Requires sections.
Here is an example:

By modifying tmpl/container.tmpl line 75 from:

<?js if (doc.requires && doc.requires.length) { ?>
    <h3 class="subsection-title">Requires</h3>

    <ul><?js doc.requires.forEach(function(r) { ?>
        <li><?js= self.linkto(r, r) ?></li>
    <?js }); ?></ul>
<?js } ?>

To:

<?js if (doc.kind === 'module' && doc.requires && doc.requires.length) { ?>
    <h3 class="subsection-title">Requires</h3>

    <ul><?js doc.requires.forEach(function(r) { ?>
        <li><?js= self.linkto(r, r) ?></li>
    <?js }); ?></ul>
<?js } ?>

It has the expected behavior with classes and seems to not alter modules.
Hope it could help ;)

If a line of code has no code in it, then it is displayed with zero height.

Is there a way to disable alphabetical order method sorting?

I generated some docs using Minami (thank you by the way -- much nicer than the default style) and have looked them on both my PC and online and the responsive sizing just isn't working properly -- at some point it stops shrinking and just cuts off the sides of the page which causes some text from the documentation to not be displayed at all and most of the hamburger/menu button is also hidden.

This also occurs in Chrome's Dev Tools, although the tools also make it slightly worse than it actually is.

Edit: title typo (mobil instead of mobile).

Upon building my project, it fails on building the tutorial because the tutorial object does not have a kind member.

https://travis-ci.org/unlhcc/HCCGo/builds/223218797

why my left nav has GLOBAL nav title, it should be module name

hi. As far as i've seen 1.1.1 introduces the sticky nav. Could you publish that version to npm?

Any way to have a Table of Contents for any given class at the top of corresponding doc page?

Your media query for the mobile version is not applied on mobile devices with high resolution, because without setting width to device-width, width returns the absolute size of the display in px.

Solution

    <meta name="viewport" content="width=device-width,initial-scale=1">

Currently, minami only lists the top level tutorials, and an option to show child tutorials in the nav as well would be really helpful. I don't know if this is a limitation of jsdoc; if that's the case, I'll open a feature request there.

code :

define([],
   /** @module my/哈囉 */
    function() {
        return {
            /** The module' `hello` property. */
            hello: function(){  
            },
        };
    }
);

generate :

<h3>Modules</h3>
    <ul>
      <li>
        <a href="module-my_%25E5%2593%2588%25E5%259B%2589.html">my/哈囉</a>
        <ul class='methods'>
          <li data-type='method'>
            <a href="module-my_%2525E5%252593%252588%2525E5%25259B%252589.html#~hello">hello</a>
          </li>
        </ul>
      </li>
    </ul>

If I click on a link on the NavBar on the Left, I would like to "jump" to the correct anchor on the right
Maybe is Fragment missing?