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.

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

V3 baseline #1403

Merged
merged 17 commits into from
Dec 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ jspm_packages
.node_repl_history

docs/_site/*
packages/core/template/*/_site

# Generated site (MarkBind)
packages/cli/test/functional/*/_site
Expand Down
9 changes: 9 additions & 0 deletions docs/_markbind/layouts/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<include src="headers/header.mbdf" />

<div id="flex-body">
<div id="content-wrapper" class="fixed-header-padding">
{{ content }}
</div>
</div>

<include src="footers/footer.mbdf" />
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
31 changes: 31 additions & 0 deletions docs/_markbind/layouts/devGuide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<include src="headers/header.mbdf" />

<div id="flex-body">
<nav id="site-nav" class="fixed-header-padding">
<div class="site-nav-top">
<div class="font-weight-bold mb-2" style="font-size: 1.25rem;">Developer Guide</div>
</div>
<div class="nav-component slim-scroll">
<site-nav>
* [Contributing]({{baseUrl}}/devGuide/devGuide.html)
* [Setting up]({{baseUrl}}/devGuide/settingUp.html)
* [Workflow]({{baseUrl}}/devGuide/workflow.html)
* [Design]({{baseUrl}}/devGuide/design.html)
* [Writing Plugins]({{baseUrl}}/devGuide/writingPlugins.html)
* [Project management]({{baseUrl}}/devGuide/projectManagement.html)
* Appendices :expanded:
* [Style guides]({{baseUrl}}/devGuide/styleGuides.html)
</site-nav>
</div>
</nav>
<div id="content-wrapper" class="fixed-header-padding">
{{ content }}
</div>
<nav id="page-nav" class="fixed-header-padding">
<div class="nav-component slim-scroll">
{{ pageNav }}
</div>
</nav>
</div>

<include src="footers/footer.mbdf" />
5 changes: 0 additions & 5 deletions docs/_markbind/layouts/devGuide/footer.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/_markbind/layouts/devGuide/header.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/_markbind/layouts/devGuide/navigation.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
<header fixed>
<head-bottom>
<link rel="stylesheet" href="{{baseUrl}}/css/main.css">
</head-bottom>

<header fixed>
<navbar type="dark">
<a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand"><img src="{{baseUrl}}/images/logo-darkbackground.png" height="20"></a>
<li><a highlight-on="exact" href="{{baseUrl}}/index.html" class="nav-link">HOME</a></li>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
<navigation>

<span style="font-weight: bolder; font-size: 1.25em;">User Guide</span>
<include src="headers/header.mbdf" />

<div id="flex-body">
<nav id="site-nav" class="fixed-header-padding">
<div class="site-nav-top">
<div class="font-weight-bold mb-2" style="font-size: 1.25rem;">User Guide</div>
</div>
<div class="nav-component slim-scroll">
<site-nav>
* [**Getting Started**]({{baseUrl}}/userGuide/gettingStarted.html)
* **Authoring Contents** :expanded:
* [Overview]({{baseUrl}}/userGuide/authoringContents.html)
Expand All @@ -28,4 +33,17 @@
* [`site.json` File]({{baseUrl}}/userGuide/siteJsonFile.html)
* [Tips & Tricks]({{baseUrl}}/userGuide/tipsAndTricks.html)
* [Glossary]({{baseUrl}}/userGuide/glossary.html)
</navigation>
</site-nav>
</div>
</nav>
<div id="content-wrapper" class="fixed-header-padding">
{{ content }}
</div>
<nav id="page-nav" class="fixed-header-padding">
<div class="nav-component slim-scroll">
{{ pageNav }}
</div>
</nav>
</div>

<include src="footers/footer.mbdf" />
5 changes: 0 additions & 5 deletions docs/_markbind/layouts/userGuide/footer.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs/_markbind/layouts/userGuide/header.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/_markbind/navigation/devGuideSections.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/_markbind/navigation/userGuideSections.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
<frontmatter>
title: "About Us"
header: header.md
footer: footer.md
</frontmatter>

# About Us
Expand Down
132 changes: 132 additions & 0 deletions docs/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,135 @@ mark {
.theme-card img {
width: 100%;
}

/* Scrollbar */

.slim-scroll::-webkit-scrollbar {
width: 5px;
}

.slim-scroll::-webkit-scrollbar-thumb {
background: #808080;
border-radius: 20px;
}

.slim-scroll::-webkit-scrollbar-track {
background: transparent;
border-radius: 20px;
}

.slim-scroll-blue::-webkit-scrollbar {
width: 5px;
}

.slim-scroll-blue::-webkit-scrollbar-thumb {
background: #00b0ef;
border-radius: 20px;
}

.slim-scroll-blue::-webkit-scrollbar-track {
background: transparent;
border-radius: 20px;
}

/* Layout containers */

#flex-body {
display: flex;
flex: 1;
}

#content-wrapper {
flex: 1;
margin: 0 auto;
min-width: 0;
max-width: 1000px;
padding: 0.8rem 20px 0 20px;
transition: 0.4s;
-webkit-transition: 0.4s;
}

#site-nav,
#page-nav {
position: sticky;
top: 0;
flex: 0 0 auto;
padding-top: 1rem;
max-width: 300px;
width: 300px;
}

#site-nav {
display: flex;
flex-direction: column;
border-right: 1px solid lightgrey;
padding-bottom: 20px;
z-index: 999;
max-height: 100vh;
}

.site-nav-top {
margin-top: 0.8rem;
padding: 0 12px 12px 12px;
}

.nav-component {
padding: 0.8rem 12px 0 12px;
overflow-y: auto;
}

#page-nav {
display: block;
max-height: 90vh;
}

#page-nav .nav-component {
border-left: 1px solid lightgrey;
max-height: 90vh;
}

@media screen and (max-width: 1299.98px) {
#page-nav {
display: none;
}
}

/* Bootstrap medium(md) responsive breakpoint */
@media screen and (max-width: 991.98px) {
#site-nav {
display: none;
}

footer {
margin-left: 60px;
}
}

/* Bootstrap small(sm) responsive breakpoint */
@media (max-width: 767.98px) {
#content-wrapper {
padding: 0 10px;
}
}

/* Bootstrap extra small(xs) responsive breakpoint */
@media screen and (max-width: 575.98px) {
#site-nav {
display: none;
}

footer {
margin-left: 0;
}
}

/* Hide site navigation when printing */
@media print {
#site-nav {
display: none;
}

#page-nav {
display: none;
}
}
2 changes: 1 addition & 1 deletion docs/devGuide/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<frontmatter>
title: "{{ title }}"
layout: devGuide
layout: devGuide.md
pageNav: default
</frontmatter>

Expand Down
2 changes: 1 addition & 1 deletion docs/devGuide/devGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<frontmatter>
title: "{{ title }}"
layout: devGuide
layout: devGuide.md
</frontmatter>

<h1 class="display-3">Developer guide</h1>
Expand Down
2 changes: 1 addition & 1 deletion docs/devGuide/projectManagement.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<frontmatter>
title: "{{ title }}"
layout: devGuide
layout: devGuide.md
pageNav: default
</frontmatter>

Expand Down
2 changes: 1 addition & 1 deletion docs/devGuide/settingUp.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<frontmatter>
title: "{{ title }}"
layout: devGuide
layout: devGuide.md
</frontmatter>

# {{ title }}
Expand Down
2 changes: 1 addition & 1 deletion docs/devGuide/styleGuides.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<frontmatter>
title: "{{ title }}"
layout: devGuide
layout: devGuide.md
pageNav: default
</frontmatter>

Expand Down
2 changes: 1 addition & 1 deletion docs/devGuide/workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<frontmatter>
title: "{{ title }}"
layout: devGuide
layout: devGuide.md
pageNav: default
</frontmatter>

Expand Down
Loading