Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use TypeDoc #333

Merged
merged 18 commits into from
May 21, 2021
Merged

Use TypeDoc #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
d441932
upgrade typescript, add typedoc
danmarshall May 20, 2021
12bbf7a
do not generate toc apitree
danmarshall May 20, 2021
d9135b7
use page title
danmarshall May 20, 2021
e9e7867
highlight sidebar from page url
danmarshall May 21, 2021
bc5fb75
common typedoc assets
danmarshall May 21, 2021
90aeb71
use typedoc css
danmarshall May 21, 2021
603537e
typedoc layout
danmarshall May 21, 2021
d90a90b
use typedoc, custom theme
danmarshall May 21, 2021
cec3029
readme to markdown for vue
danmarshall May 21, 2021
ba55892
use typedoc
danmarshall May 21, 2021
9513adf
add sanddance-specs
danmarshall May 21, 2021
a730e4f
add title
danmarshall May 21, 2021
69ec5f7
style changes wip
danmarshall May 21, 2021
33fb82c
fix color & spacing
danmarshall May 21, 2021
7c63024
fix api urls
danmarshall May 21, 2021
8fcf322
fix font size and spacing
danmarshall May 21, 2021
5a73b0e
add link to sanddance-specs
danmarshall May 21, 2021
d639ff6
remove c-tree classes
danmarshall May 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ typings/
docs/**/*.map
docs/.jekyll-cache
docs/.jekyll-metadata
docs/docs/**/assets

# powerbi builds
.tmp
Expand Down
8 changes: 4 additions & 4 deletions docs/_data/tree.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
"tree": "sanddance",
"url": "/docs/sanddance/v3"
},
{
"tree": "sanddance-specs",
"url": "/docs/sanddance-specs/v1"
},
{
"tree": "sanddance-react",
"url": "/docs/sanddance-react/v3"
Expand All @@ -36,10 +40,6 @@
}
],
"Resources": [
{
"tree": "API Reference",
"url": "/docs/api"
},
{
"tree": "Vega",
"url": "https://vega.github.io/"
Expand Down
3 changes: 2 additions & 1 deletion docs/_layouts/default.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>SandDance</title>
<title>SandDance {{ page.title }}</title>
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/main.css">
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/typedoc.css">
<link rel="shortcut icon" href="{{ site.baseurl }}/favicon.ico" />
</head>

Expand Down
14 changes: 12 additions & 2 deletions docs/_layouts/docs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@
</div>
</nav>

{% assign match = '' %}
{% for tree in site.data.tree %}
{% for branch in tree[1] %}
{% assign checkArray = page.url | split:branch.url %}
{% if checkArray[0] == '' %}
{% assign match = branch.url %}
{% endif %}
{% endfor %}
{% endfor %}

<section class="c-page-content">
<div class="o-wrapper">
<div class="o-layout o-layout--large">
Expand Down Expand Up @@ -41,8 +51,8 @@
{% capture branch_link %}{{ site.baseurl }}{{branch_url}}{% endcapture %}
{% endif %}

<li class="c-tree__item {% if page_url == tree_url %} is-active{% endif %}">
<a href="{{ branch_link }}" {% if page_url == branch_url %}class="is-active"{% endif %}>
<li class="c-tree__item {% if branch.url == match %} is-active{% endif %}">
<a href="{{ branch_link }}" {% if branch.url == match %}class="is-active"{% endif %}>
{{ branch.tree }}
</a>
</li>
Expand Down
74 changes: 74 additions & 0 deletions docs/_layouts/typedoc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
layout: docs
---

<div class="typedoc">

{{ content }}

<footer class="with-border-bottom o-wrapper">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>

<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>

</div>
3 changes: 0 additions & 3 deletions docs/_sass/components/_components.page-foot.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,4 @@ footer {
margin-left: initial;
padding-left: initial;
}
a {
color: #0078d7;
}
}
8 changes: 0 additions & 8 deletions docs/_sass/components/_components.tree.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,6 @@
}
}

@include mq($from: tablet) {
position: sticky;
top: $spacing-huge;
max-height: calc(100vh - #{$spacing*7 - $spacing-small});
overflow-y: auto;
@include inuit-font-size($inuit-font-size-h4);
}

ul {
margin-left: 0;
overflow: hidden;
Expand Down
9 changes: 3 additions & 6 deletions docs/_sass/elements/_elements.code.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,20 +55,17 @@ pre.highlight {
.language-typescript:before { content: 'TypeScript'; }

code {
padding-bottom: $spacing-tiny;
padding-right: $spacing-tiny;
padding-left: $spacing-tiny;
background: lighten($ms-black-100, 3%);
border: 1px solid $ms-black-200;
color: $ms-black-500;
@include inuit-font-size($inuit-font-size-h5);

.dark-theme & {
background: $ms-black-600;
border-color: $ms-black-500;
color: $ms-black-100;
}

pre & {
border: 0;
display: block;
overflow: auto;
}
}
10 changes: 9 additions & 1 deletion docs/_sass/elements/_elements.links.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,20 @@ a {
text-decoration: underline;
}

.c-page-main & {
.c-page-main &, footer & {
color: $ms-sky-400;

.dark-theme & {
color: $ms-cyan-400;
}

&:hover,
&:focus {
color: $ms-sky-500;

.dark-theme & {
color: $ms-cyan-200;
}
}
}
}
Expand Down
Loading