Merge pull request #3 from mkdocs-material/statusbadge

added example for page statuses

Author: squidfunk

examples/statusbadge/docs/deprecated.md

@@ -0,0 +1,5 @@
+---
+status: deprecated
+---
+
+# This is a page with deprecated content

examples/statusbadge/docs/happy.md

@@ -0,0 +1,7 @@
+---
+status: happy
+---
+
+# Happy, happy page!
+
+This page has a custom page status.

examples/statusbadge/docs/index.md

@@ -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
+
+
+

examples/statusbadge/docs/newsect/index.md

@@ -0,0 +1,5 @@
+---
+status: new
+---
+
+# Brand new content!

examples/statusbadge/docs/newsect/other.md

@@ -0,0 +1 @@
+# Another page in the new section

examples/statusbadge/docs/stylesheets/extra.css

@@ -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