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

Simplify local overrides #4585

Merged
merged 4 commits into from Nov 3, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/publish.yml
Expand Up @@ -91,7 +91,9 @@ jobs:
ghcr.io/${{ github.event.repository.full_name }}:${{ github.event.release.tag_name }}

- name: Check Docker image
run:
working-directory: /tmp
run: |
docker run --rm -i -v ${PWD}:/docs ${{ github.event.repository.full_name }} new .
docker run --rm -i -v ${PWD}:/docs ${{ github.event.repository.full_name }} build

- name: Publish Docker image
Expand Down
4 changes: 0 additions & 4 deletions docs/alternatives.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Alternatives

There are tons of static site generators and themes out there and choosing the
Expand Down
4 changes: 0 additions & 4 deletions docs/browser-support.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Browser support

Material for MkDocs goes at great lengths to support the largest possible range
Expand Down
4 changes: 0 additions & 4 deletions docs/changelog/index.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Changelog

## Material for MkDocs
Expand Down
4 changes: 0 additions & 4 deletions docs/creating-your-site.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Creating your site

After you've [installed] Material for MkDocs, you can bootstrap your project
Expand Down
4 changes: 0 additions & 4 deletions docs/customization.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Customization

Project documentation is as diverse as the projects themselves and Material for
Expand Down
4 changes: 0 additions & 4 deletions docs/getting-started.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Getting started

Material for MkDocs is a theme for [MkDocs], a static site generator geared
Expand Down
4 changes: 3 additions & 1 deletion docs/index.md
@@ -1,4 +1,6 @@
---
template: overrides/home.html
template: home.html
title: Material for MkDocs
---

Welcome to Material for MkDocs.
4 changes: 0 additions & 4 deletions docs/insiders/changelog.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Changelog

## Material for MkDocs Insiders
Expand Down
1 change: 0 additions & 1 deletion docs/insiders/getting-started.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
title: Getting started with Insiders
---

Expand Down
1 change: 0 additions & 1 deletion docs/insiders/index.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
title: Insiders
---

Expand Down
4 changes: 0 additions & 4 deletions docs/license.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# License

**MIT License**
Expand Down
4 changes: 0 additions & 4 deletions docs/philosophy.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Philosophy

Before settling for Material for MkDocs, it's a good idea to understand the
Expand Down
4 changes: 0 additions & 4 deletions docs/publishing-your-site.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Publishing your site

The great thing about hosting project documentation in a `git` repository is
Expand Down
1 change: 0 additions & 1 deletion docs/reference/admonitions.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/alert-outline
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/annotations.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/plus-circle
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/buttons.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/gesture-tap-button
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/code-blocks.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/code-json
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/content-tabs.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/tab
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/data-tables.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/table-edit
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/diagrams.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/graph-outline
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/footnotes.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/format-align-bottom
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/formatting.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/format-font
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/grids.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/view-grid-plus
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/icons-emojis.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/emoticon-happy-outline
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/images.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/image-frame
---

Expand Down
4 changes: 0 additions & 4 deletions docs/reference/index.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Reference

Material for MkDocs is packed with many great features that make technical
Expand Down
1 change: 0 additions & 1 deletion docs/reference/lists.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/format-list-bulleted
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/mathjax.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/alphabet-greek
---

Expand Down
1 change: 0 additions & 1 deletion docs/reference/tooltips.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/tooltip-plus
status: new
---
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/adding-a-comment-system.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Adding a comment system

Material for MkDocs allows to easily add the third-party comment system of your
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/adding-a-git-repository.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Adding a git repository

If your documentation is related to source code, Material for MkDocs provides
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/building-for-offline-usage.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Building for offline usage

If you want to ship your documentation together with your product, MkDocs has
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/changing-the-colors.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Changing the colors

As any proper Material Design implementation, Material for MkDocs supports
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/changing-the-fonts.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Changing the fonts

Material for MkDocs makes it easy to change the typeface of your project
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/changing-the-language.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Changing the language

Material for MkDocs supports internationalization (i18n) and provides
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/changing-the-logo-and-icons.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Changing the logo and icons

When installing Material for MkDocs, you immediately get access to _over 8,000
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/ensuring-data-privacy.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Ensuring data privacy

Material for MkDocs makes compliance with data privacy regulations very easy,
Expand Down
1 change: 0 additions & 1 deletion docs/setup/extensions/index.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
title: Extensions
---

Expand Down
4 changes: 0 additions & 4 deletions docs/setup/extensions/python-markdown-extensions.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Python Markdown Extensions

The [Python Markdown Extensions] package is an excellent collection of
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/extensions/python-markdown.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Python Markdown

Material for MkDocs supports a large number of [Python Markdown] extensions,
Expand Down
1 change: 0 additions & 1 deletion docs/setup/setting-up-a-blog.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
status: new
---

Expand Down
4 changes: 0 additions & 4 deletions docs/setup/setting-up-navigation.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Setting up navigation

A clear and concise navigation structure is an important aspect of good project
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/setting-up-site-analytics.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Setting up site analytics

As with any other service offered on the web, understanding how your project
Expand Down
1 change: 0 additions & 1 deletion docs/setup/setting-up-site-search.md
@@ -1,5 +1,4 @@
---
template: overrides/main.html
search:
boost: 1.05
---
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/setting-up-social-cards.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Setting up social cards

Social cards, also known as social previews, are images that are displayed when
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/setting-up-tags.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Setting up tags

Material for MkDocs adds first-class support for categorizing pages with tags,
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/setting-up-the-footer.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Setting up the footer

The footer of your project documentation is a great place to add links to
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/setting-up-the-header.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Setting up the header

Material for MkDocs' header can be customized to show an announcement bar that
Expand Down
4 changes: 0 additions & 4 deletions docs/setup/setting-up-versioning.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# Setting up versioning

Material for MkDocs makes it easy to deploy multiple versions of your project
Expand Down
4 changes: 0 additions & 4 deletions docs/upgrade.md
@@ -1,7 +1,3 @@
---
template: overrides/main.html
---

# How to upgrade

Upgrade to the latest version with:
Expand Down
10 changes: 0 additions & 10 deletions material/overrides/blog.html

This file was deleted.

3 changes: 0 additions & 3 deletions material/overrides/main.html
Expand Up @@ -14,9 +14,6 @@
<strong>Twitter</strong>
</a>
{% endblock %}
{% block content %}
{% include "overrides/partials/content.html" %}
{% endblock %}
{% block scripts %}
{{ super() }}
<script src="{{ 'overrides/assets/javascripts/bundle.d665d539.min.js' | url }}"></script>
Expand Down