-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from mkdocs-material/statusbadge
added example for page statuses
- Loading branch information
Showing
7 changed files
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
status: deprecated | ||
--- | ||
|
||
# This is a page with deprecated content |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
status: happy | ||
--- | ||
|
||
# Happy, happy page! | ||
|
||
This page has a custom page status. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Page Status Example | ||
|
||
The example shows how to add a [page status] to a page. This works for | ||
section index pages as well as 'normal' pages. | ||
|
||
You can add the existing status identifiers `new` | ||
and `deprecated` but also define custom ones by: | ||
|
||
1. defining the tooltip in your `mkdocs.yml` | ||
2. defining the icon to use in your `extra.css` | ||
|
||
[page status]: https://squidfunk.github.io/mkdocs-material/reference/#setting-the-page-status | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
status: new | ||
--- | ||
|
||
# Brand new content! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Another page in the new section |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
site_name: Page Status Example | ||
|
||
theme: | ||
name: material | ||
features: | ||
- navigation.indexes | ||
|
||
extra: | ||
status: | ||
new: Recently Added | ||
happy: Happy! | ||
|
||
extra_css: | ||
- stylesheets/extra.css | ||
|
||
nav: | ||
- "Home": index.md | ||
- "Deprecated": deprecated.md | ||
- "Happy": happy.md | ||
- "New Section": | ||
- newsect/index.md | ||
- "Other": newsect/other.md |