diff --git a/README.md b/README.md index 26aef83..5619856 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ THEME = alchemy.path() ## Usage -Visit the [Settings wiki](https://github.com/nairobilug/pelican-alchemy/wiki/Settings) for examples: +Visit the [Settings docs](docs/settings.md) for examples: - **SITESUBTITLE**: Subtitle that appears in the header. - **SITEIMAGE**: Image that appears in the header. @@ -141,7 +141,7 @@ Example [pelicanconf.py](https://github.com/nairobilug/pelican-alchemy/blob/demo ### Tips & Tricks -https://github.com/nairobilug/pelican-alchemy/wiki/Tips +[See documentation page](docs/pelican-tips.md) ## How to Contribute diff --git a/docs/README.md b/docs/README.md index ac93b94..de439b0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -Welcome to the pelican-alchemy wiki! +Welcome to the pelican-alchemy documentation! -- [Pelican Tips](wiki/Pelican-Tips) -- [Settings](wiki/Settings) \ No newline at end of file +- [Pelican Tips](pelican-tips.md) +- [Settings](settings.md) diff --git a/docs/pelican-tips.md b/docs/pelican-tips.md index 4318a4e..c54709b 100644 --- a/docs/pelican-tips.md +++ b/docs/pelican-tips.md @@ -1,3 +1,5 @@ +# Pelican Tips + ## Bootstrap Classes To have Bootstrap classes set for rendered html (`.table`, `.img-fluid` etc), use the [Bootstrapify](https://github.com/ingwinlu/pelican-bootstrapify) Pelican plugin. @@ -67,4 +69,4 @@ In your Pelican config: # Default value is ['index', 'tags', 'categories', 'authors', 'archives'] DIRECT_TEMPLATES = ['index', 'tags', 'categories', 'authors', 'archives', 'sitemap'] SITEMAP_SAVE_AS = 'sitemap.xml' -``` \ No newline at end of file +``` diff --git a/docs/settings.md b/docs/settings.md index dcff669..b77083e 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -1,3 +1,5 @@ +# Settings + Unless otherwise specified, settings that refer to paths can be either absolute or relative to the configuration file. ## SITESUBTITLE @@ -120,4 +122,4 @@ GAUGES = '...' GOOGLE_ANALYTICS = '...' PIWIK_URL = '...' PIWIK_SITE_ID = '...' -``` \ No newline at end of file +```