mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-30 18:24:35 +01:00
Merge branch 'refactor/rxjs-typescript' into feature/landing-page
This commit is contained in:
commit
32f45d2060
@ -150,12 +150,14 @@ following command:
|
|||||||
mkdocs serve
|
mkdocs serve
|
||||||
```
|
```
|
||||||
|
|
||||||
Point your browser to [http://localhost:8000][11] and your documentation should
|
Point your browser to http://localhost:8000 and your documentation should great
|
||||||
great you in a new look. If you're starting from scratch, the following
|
you in a new look. If you're starting from scratch, the following configuration
|
||||||
configuration can be used as a starting point:
|
can be used as a starting point:
|
||||||
|
|
||||||
??? summary "Example configuration"
|
??? summary "Example configuration"
|
||||||
|
|
||||||
|
This is an excerpt from the [`mkdocs.yml`][11] used to render these pages:
|
||||||
|
|
||||||
``` yaml
|
``` yaml
|
||||||
# Project information
|
# Project information
|
||||||
site_name: Material for MkDocs
|
site_name: Material for MkDocs
|
||||||
@ -205,7 +207,7 @@ configuration can be used as a starting point:
|
|||||||
permalink: true
|
permalink: true
|
||||||
```
|
```
|
||||||
|
|
||||||
[11]: http://localhost:8000
|
[11]: https://github.com/squidfunk/mkdocs-material/blob/master/mkdocs.yml
|
||||||
|
|
||||||
### Feature flags
|
### Feature flags
|
||||||
|
|
||||||
@ -246,13 +248,14 @@ Note that all *top-level pages* (i.e. all top-level entries that directly refer
|
|||||||
to an `*.md` file) defined inside the `nav` entry of `mkdocs.yml` will be
|
to an `*.md` file) defined inside the `nav` entry of `mkdocs.yml` will be
|
||||||
grouped under the first tab which will receive the title of the first page.
|
grouped under the first tab which will receive the title of the first page.
|
||||||
|
|
||||||
If you want to maintain absolute control over the navigation bar, you can opt
|
This means that there will effectively be no collapsible subsections for the
|
||||||
in to group all top-level pages under one entry (so all top-level entries have
|
first tab, as each subsection is rendered as another tab. If you want more
|
||||||
subentries now). This way you can have nested navigation items in conjunction
|
fine-grained control, i.e., collapsible subsections for the first tab, you can
|
||||||
with tabs, as nesting works as expected from the second level on when tabs are
|
move all *top-level pages into a subsection*, so that the top-level is entirely
|
||||||
enabled. Keep in mind that mobile navigation isn't affected by tabs, however,
|
made up of subsections. Note that tabs are only shown for larger screens, so
|
||||||
which means that your top-level entries correspond to top-level mobile
|
make sure that navigation is plausible on mobile devices.
|
||||||
navigation items.
|
|
||||||
|
As an example, see the [`mkdocs.yml`][11] used to render these pages.
|
||||||
|
|
||||||
### Language
|
### Language
|
||||||
|
|
||||||
|
File diff suppressed because one or more lines are too long
1
material/assets/javascripts/bundle.091f8c32.min.js.map
Normal file
1
material/assets/javascripts/bundle.091f8c32.min.js.map
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -1,10 +1,10 @@
|
|||||||
{
|
{
|
||||||
"assets/javascripts/bundle.js": "assets/javascripts/bundle.8d539fc7.min.js",
|
"assets/javascripts/bundle.js": "assets/javascripts/bundle.091f8c32.min.js",
|
||||||
"assets/javascripts/bundle.js.map": "assets/javascripts/bundle.8d539fc7.min.js.map",
|
"assets/javascripts/bundle.js.map": "assets/javascripts/bundle.091f8c32.min.js.map",
|
||||||
"assets/javascripts/vendor.js": "assets/javascripts/vendor.5b460a48.min.js",
|
"assets/javascripts/vendor.js": "assets/javascripts/vendor.5b460a48.min.js",
|
||||||
"assets/javascripts/vendor.js.map": "assets/javascripts/vendor.5b460a48.min.js.map",
|
"assets/javascripts/vendor.js.map": "assets/javascripts/vendor.5b460a48.min.js.map",
|
||||||
"assets/javascripts/worker/search.js": "assets/javascripts/worker/search.7f7c8775.min.js",
|
"assets/javascripts/worker/search.js": "assets/javascripts/worker/search.7f7c8775.min.js",
|
||||||
"assets/javascripts/worker/search.js.map": "assets/javascripts/worker/search.7f7c8775.min.js.map",
|
"assets/javascripts/worker/search.js.map": "assets/javascripts/worker/search.7f7c8775.min.js.map",
|
||||||
"assets/stylesheets/main.css": "assets/stylesheets/main.7584781b.min.css",
|
"assets/stylesheets/main.css": "assets/stylesheets/main.898d9115.min.css",
|
||||||
"assets/stylesheets/palette.css": "assets/stylesheets/palette.4444686e.min.css"
|
"assets/stylesheets/palette.css": "assets/stylesheets/palette.4444686e.min.css"
|
||||||
}
|
}
|
File diff suppressed because one or more lines are too long
1
material/assets/stylesheets/main.898d9115.min.css
vendored
Normal file
1
material/assets/stylesheets/main.898d9115.min.css
vendored
Normal file
File diff suppressed because one or more lines are too long
@ -41,7 +41,7 @@
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
{% block styles %}
|
{% block styles %}
|
||||||
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.7584781b.min.css' | url }}">
|
<link rel="stylesheet" href="{{ 'assets/stylesheets/main.898d9115.min.css' | url }}">
|
||||||
{% if palette.primary or palette.accent %}
|
{% if palette.primary or palette.accent %}
|
||||||
<link rel="stylesheet" href="{{ 'assets/stylesheets/palette.4444686e.min.css' | url }}">
|
<link rel="stylesheet" href="{{ 'assets/stylesheets/palette.4444686e.min.css' | url }}">
|
||||||
{% endif %}
|
{% endif %}
|
||||||
@ -179,7 +179,7 @@
|
|||||||
</div>
|
</div>
|
||||||
{% block scripts %}
|
{% block scripts %}
|
||||||
<script src="{{ 'assets/javascripts/vendor.5b460a48.min.js' | url }}"></script>
|
<script src="{{ 'assets/javascripts/vendor.5b460a48.min.js' | url }}"></script>
|
||||||
<script src="{{ 'assets/javascripts/bundle.8d539fc7.min.js' | url }}"></script>
|
<script src="{{ 'assets/javascripts/bundle.091f8c32.min.js' | url }}"></script>
|
||||||
{%- set translations = {} -%}
|
{%- set translations = {} -%}
|
||||||
{%- for key in [
|
{%- for key in [
|
||||||
"clipboard.copy",
|
"clipboard.copy",
|
||||||
|
@ -145,7 +145,6 @@ export function setupInstantLoading(
|
|||||||
/* Filter state changes to dispatch */
|
/* Filter state changes to dispatch */
|
||||||
const push$ = state$
|
const push$ = state$
|
||||||
.pipe(
|
.pipe(
|
||||||
distinctUntilChanged((prev, next) => prev.url.href === next.url.href),
|
|
||||||
filter(({ url }) => !isAnchorLocation(url)),
|
filter(({ url }) => !isAnchorLocation(url)),
|
||||||
share()
|
share()
|
||||||
)
|
)
|
||||||
@ -164,6 +163,7 @@ export function setupInstantLoading(
|
|||||||
/* Emit location change */
|
/* Emit location change */
|
||||||
merge(push$, pop$)
|
merge(push$, pop$)
|
||||||
.pipe(
|
.pipe(
|
||||||
|
distinctUntilChanged((prev, next) => prev.url.href === next.url.href),
|
||||||
pluck("url")
|
pluck("url")
|
||||||
)
|
)
|
||||||
.subscribe(location$)
|
.subscribe(location$)
|
||||||
|
@ -164,7 +164,6 @@ kbd {
|
|||||||
// Inline code blocks
|
// Inline code blocks
|
||||||
code {
|
code {
|
||||||
margin: 0 px2em(4px, 13.6px);
|
margin: 0 px2em(4px, 13.6px);
|
||||||
padding: px2em(1px, 13.6px) 0;
|
|
||||||
font-size: px2em(13.6px);
|
font-size: px2em(13.6px);
|
||||||
word-break: break-word;
|
word-break: break-word;
|
||||||
background-color: var(--md-code-bg-color);
|
background-color: var(--md-code-bg-color);
|
||||||
@ -260,7 +259,6 @@ kbd {
|
|||||||
// Text highlighting marker
|
// Text highlighting marker
|
||||||
mark {
|
mark {
|
||||||
margin: 0 px2em(4px, 16px);
|
margin: 0 px2em(4px, 16px);
|
||||||
padding: px2em(1px, 16px) 0;
|
|
||||||
word-break: break-word;
|
word-break: break-word;
|
||||||
background-color: transparentize($clr-yellow-500, 0.5);
|
background-color: transparentize($clr-yellow-500, 0.5);
|
||||||
border-radius: px2rem(2px);
|
border-radius: px2rem(2px);
|
||||||
|
@ -32,7 +32,6 @@
|
|||||||
ins.critic,
|
ins.critic,
|
||||||
.critic.comment {
|
.critic.comment {
|
||||||
margin: 0 px2em(4px, 16px);
|
margin: 0 px2em(4px, 16px);
|
||||||
padding: px2em(1px, 16px) 0;
|
|
||||||
border-radius: px2rem(2px);
|
border-radius: px2rem(2px);
|
||||||
box-decoration-break: clone;
|
box-decoration-break: clone;
|
||||||
}
|
}
|
||||||
@ -74,6 +73,7 @@
|
|||||||
margin: 1em 0;
|
margin: 1em 0;
|
||||||
padding-right: px2rem(16px);
|
padding-right: px2rem(16px);
|
||||||
padding-left: px2rem(16px);
|
padding-left: px2rem(16px);
|
||||||
|
overflow: auto;
|
||||||
box-shadow: none;
|
box-shadow: none;
|
||||||
|
|
||||||
// Decrease spacing on first element
|
// Decrease spacing on first element
|
||||||
|
Loading…
Reference in New Issue
Block a user