"Hello Dolly" is a very basic
mkdocs plugin that searches in
all your mkdocs documents the tag {{dolly}} and substitutes it with a
random lyrics taken from "Hello Dolly!", the main song of the musical
of the same name.
It was inspired by the once built-in plugin of WordPress, and it's main purpose is to help understanding how to write a simple plugin for mkdocs.
If you want to try this plugin as-it-is, follow these steps:
-
Download this repo and (eventually) unzip it in a folder
-
Inside the project folder, execute the command
python setup.py developto install the plugin on your local machine. -
Go to your mkdocs project folder, edit the
mkdocs.ymlfile and add these few lines at the end:plugins: - hello-dolly
That's it.
Now, each time you'll write the tag {{dolly}}
inside any page in your mkdocs document folder,
this plugin will substitute that tag with
a random lyric taken from the main song of the
musical "Hello Dolly".
For example, you could edit the docs/index.md
file and insert the tag in any place, like this:
# Welcome to MkDocs
For full documentation visit [mkdocs.org](http://mkdocs.org).
{{dolly}}
## Commands