bitovi / bitovi/documentjs

Can't document `typography.less`

Open
#205 2 comments 0 reactions 0 assignees View on GitHub
bug style-guide
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

When I try to generate documentation from a file named `typography.less` DocumentJS seems to ignore it. I assume it might be because the theme files also use a `typography.less` file, but not sure.

At the top of `typography.less` I have:

```
/**
* @stylesheet typography.less Typography
* @parent styles-theme 1
*
* @description
* Typography should be used as a baseline to indicate hierarchy on every page of the application.
* Always choose the appropriate text size for the specific part being laid out, to communicate
* importance among headlines, content, microcopy and controls.
*
**/
```

When I generate the docs, Typography is not listed in the menu:
![screen shot 2015-09-07 at 9 32 08 am](https://cloud.githubusercontent.com/assets/326843/9718659/5b70a1f4-5543-11e5-9197-d980b9f9f629.png)

If I change the `@stylesheet` declaration to anything else, like this:

```
/**
* @stylesheet typography Typography
...
```

Then the generated docs add Typography to the nav:
![screen shot 2015-09-07 at 9 33 48 am](https://cloud.githubusercontent.com/assets/326843/9718675/8ffcf684-5543-11e5-88a9-950fc9215d30.png)

What's strange is that I have another project where `typography.less` is used as the name and, as far as I know, it works. So perhaps this is only isolated to my project, but I'd like to know if it can be reproduced.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.