diff options
| author | Minh Nguyễn <mxn@1ec5.org> | 2016-12-20 17:32:06 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-12-20 17:32:06 -0800 |
| commit | 906d700ccd1aedf262b8a29b88203c614c105805 (patch) | |
| tree | 908648ccaa03cd830e27cecd9b90f85f5e46d8e3 | |
| parent | 20b82c8fd1de49c096d5c6656401d18af262c46f (diff) | |
| download | qtlocation-mapboxgl-906d700ccd1aedf262b8a29b88203c614c105805.tar.gz | |
[ios, macos] Indicate protocols, abstract classes in documentation navigation (#7478)
* [ios, macos] Italicize protocols, abstract classes in doc nav
Italicize protocols and abstract classes in the generated documentation’s navigation sidebar.
* [ios, macos] Denote protocols, abstract classes with glosses
Instead of oblique text, use a parenthetical gloss to denote a protocol or abstract class.
| -rw-r--r-- | platform/darwin/docs/theme/assets/css/jazzy.css.scss | 25 | ||||
| -rw-r--r-- | platform/darwin/docs/theme/templates/nav.mustache | 2 |
2 files changed, 26 insertions, 1 deletions
diff --git a/platform/darwin/docs/theme/assets/css/jazzy.css.scss b/platform/darwin/docs/theme/assets/css/jazzy.css.scss index 9c1f347142..6b4dffc879 100644 --- a/platform/darwin/docs/theme/assets/css/jazzy.css.scss +++ b/platform/darwin/docs/theme/assets/css/jazzy.css.scss @@ -51,6 +51,7 @@ $navigation_bg_color: #fbfbfb; $navigation_task_color: $link_color; $section_name_color: $color_darkblue; +$navigation_gloss_color: #999; // ----- Content @@ -367,6 +368,30 @@ pre code { color: $navigation_task_color; } +%nav-group-task-gloss { + color: $navigation_gloss_color; + font-size: 90%; + margin-left: 0.5em; +} + +.nav-group-task[data-url^="Protocols/"] > .nav-group-task-link::after { + @extend %nav-group-task-gloss; + content: "(Protocol)"; +} + +.nav-group-task[data-name="MGLForegroundStyleLayer"], +.nav-group-task[data-name="MGLMultiPoint"], +.nav-group-task[data-name="MGLShape"], +.nav-group-task[data-name="MGLSource"], +.nav-group-task[data-name="MGLStyleLayer"], +.nav-group-task[data-name="MGLTileSource"], +.nav-group-task[data-name="MGLVectorStyleLayer"] { + .nav-group-task-link::after { + @extend %nav-group-task-gloss; + content: "(Abstract Class)"; + } +} + .nav-group-name > .small-heading, .nav-group-task-link { display: block; diff --git a/platform/darwin/docs/theme/templates/nav.mustache b/platform/darwin/docs/theme/templates/nav.mustache index 7584f49652..bfbd8e7d78 100644 --- a/platform/darwin/docs/theme/templates/nav.mustache +++ b/platform/darwin/docs/theme/templates/nav.mustache @@ -5,7 +5,7 @@ <a class="small-heading" href="{{path_to_root}}{{section}}.html">{{section}}<span class="anchor-icon" /></a> <ul class="nav-group-tasks"> {{#children}} - <li class="nav-group-task" data-name="{{name}}"> + <li class="nav-group-task" data-name="{{name}}" data-url="{{url}}"> <a title="{{name}}" class="nav-group-task-link" href="{{path_to_root}}{{url}}">{{name}}</a> </li> {{/children}} |