Skip to content

Commit

Permalink
Update Readme, bump to 0.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Lars Wilhelmer committed Jun 15, 2022
1 parent b257426 commit c88e15c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# mkdocs-add-teaser

An MkDocs plugin to add a CSS class to the first paragraph after the first heading 1 in all pages of your project.
An MkDocs plugin to customize the first paragraph of your pages, and to use it as the page's meta description.

This is useful if the first paragraph of your pages always contains information that should stand out from the rest of the text, e.g., that should be printed in bold.
This is useful if the first paragraph of your pages

The name of the CSS class can be customized.
* contains information that should stand out from the rest of the text, e.g., should be printed in bold ("teaser" text)
* should appear as the page description in search engines (for SEO).

The plugin detects and uses the first paragraph after the first heading 1 in all pages of your project.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name='mkdocs-add-teaser',
version='0.6.0',
version='0.7.0',
description='A MkDocs plugin to add a CSS class to the first paragraph after the first heading 1 in all pages of your project.',
long_description='',
keywords='mkdocs css',
Expand Down

0 comments on commit c88e15c

Please sign in to comment.