mkdocs/mkdocs-bootswatch

MkDocs Bootswatch Themes

MkDocs Bootswatch Themes

See the documentation for more details:

https://mkdocs.github.io/mkdocs-bootswatch/

Contributing

These themes all inherit from the mkdocs theme which ships with MkDocs. These themes primarily contain CSS which replaces/overrides the CSS in the mkdocs theme. All other improvements should be made to the mkdocs theme in the project hosted at https://github.com/mkdocs/mkdocs.

Release Notes

Version 1.1 (2020/02/22)

• Update to support MkDocs version 1.1.
• Update to support Bootstrap 4.
  • Remove the amelia and readable themes, which were dropped by Bootswatch.
  • Add Bootswatch's new themes: darkly, litera, lumen, lux, materia, minty, pulse, sandstone, solar, and superhero.
• Port changes from the parent mkdocs theme:
  • Properly handle the scroll offset for anchors.
  • Improve support for long dropdowns.
  • Improve support for tall nav headers
  • Use toc_tokens to generate the TOC
• Fix padding/background color issues with hljs code blocks.

Version 1.0 (2018/08/03)

• Inherit from the mkdocs theme and get all the parent theme's features.
• Update to support MkDocs version 1.0.

Version 0.5 (2018/02/16)

• Fix padding of code blocks
• Generate all themes from one common base.
• Update templates for MkDocs v0.17.
• Update per-theme CSS to match MkDocs.
• Update to FontAwesome 4.5.0.
• Improve code highlighting colors for all themes.
• Support admonitions.

Version 0.4 (2016/03/02)

• Some styling tweaks.
• Add support for permalinks.
• Support inverse nav headers.

Version 0.3.1 (2016/02/24)

• Fix docs deployment.

Version 0.3 (2016/02/24)

• Add support for sub-level nav.

Version 0.2 (2018/02/06)

• Add search modal to all themes.
• Automate releases.

Version 0.1 (2015/06/23)

• Initial release.

mkdocs-bootswatch's Issues

Adapt new bootswatch theme for mkdocs

What are the steps for adapting a new bootswatch theme for mkdocs given the recent version bump of mkdocs-bootswatch? I'd like to use lux and would be happy to create a PR with this addition.

I've tried creating a custom_dir folder which includes the bootstrap-custom.min.css file for lux. However, when the page renders, the navigation bar sits on top of the main content.

changing bold font in lux theme

Hello! I've been using the lux theme for my mkdocs site, however bold font isn't substantially different from standard text. I've been trying to find a way to edit my css/extra.css file to change this, but I haven't been able to figure out how to do this. Is there a way to adapt the lux theme this way?

Bootstrap - Navigation - menus - multple rows - overlaps content

See original issue: mkdocs/mkdocs#210

No such file or directory: u'/usr/local/lib/python2.7/dist-packages/mkdocs_bootswatch/flatly/mkdocs_theme.yml'

I've installed mkdocs and bootswatch using pip:

$ sudo pip install mkdocs
$ sudo pip install mkdocs-bootswatch

Then i've configure the flatly theme in my mkdocs site configuration, and I end up with:

$ mkdocs -v build
DEBUG   -  Loading configuration file: /srv/admin-docs/site-markdown/mkdocs.yml 
DEBUG   -  [Errno 2] No such file or directory: u'/usr/local/lib/python2.7/dist-packages/mkdocs_bootswatch/flatly/mkdocs_theme.yml' 

And indeed, the file there does not exist.

Am I doing something wrong?

Support include_next_prev in all themes

See: mkdocs/mkdocs#479

Use template inheritance

As per #36 (comment):

the 01.7 release of MkDocs includes support for themes to extend other themes. Rather than needing to "generate" the themes here, I wonder of inheritance should be used instead. In fact, I expect that these themes could all extend the mkdocs theme. That way, they would get any (non CSS) updates automatically. If, for some reason, they can't extend the mkdocs theme, they should be able to extend on of their own (set one as the base which is a complete theme and all other extend it only providing the files that differ). I accepted this PR anyway because it included CSS changes which still needed to be made, but using inheritance should cut down on the work to keep things up-to-date.

Disable code highlighting?

If I write some logs with the ``` syntax:

```
Status: Image is up to date for ...
```

Then mkdocs (or highlight.js) detects some language and highlight several keywords, as shown here:

I have tried to do as explained here mkdocs/mkdocs#1144 and wrote :

```text
Status: Image is up to date for ...
```

But this did not change anything.

How can I disable code highlighting? I am asking here because of the thread mkdocs/mkdocs#1144 they say it might be related to the theme.

Theme Cuts-off top of page

Installed the bootswatch package theme, but it cuts off the title pages.

(Numbers covered for security reasons)
Any ideas how to fix?

mkdocs-bootswatch==0.4.0 is not compatible with mkdocs==0.17.0

Here what I get with the above versions. Seems to work fine with the mkdocs==0.16.3.

skhegay@C02T52AWFVH4-lm (fix-dependency)✗ % mkdocs serve                                                                       ~/Projects/yamas_userguide_2.0
INFO    -  Building documentation...
WARNING -  The theme 'yeti' does not appear to have a configuration file. Please upgrade to a current version of the theme.
INFO    -  Cleaning site directory
INFO    -  Template skipped: 'search.html'. Not found in template directories.
ERROR   -  Error building page index.md
Traceback (most recent call last):
  File "/usr/local/bin/mkdocs", line 11, in <module>
    sys.exit(cli())
  File "/Library/Python/2.7/site-packages/click/core.py", line 722, in __call__
    return self.main(*args, **kwargs)
  File "/Library/Python/2.7/site-packages/click/core.py", line 697, in main
    rv = self.invoke(ctx)
  File "/Library/Python/2.7/site-packages/click/core.py", line 1066, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/Library/Python/2.7/site-packages/click/core.py", line 895, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/Library/Python/2.7/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "/Library/Python/2.7/site-packages/mkdocs/__main__.py", line 127, in serve_command
    livereload=livereload
  File "/Library/Python/2.7/site-packages/mkdocs/commands/serve.py", line 114, in serve
    config = builder()
  File "/Library/Python/2.7/site-packages/mkdocs/commands/serve.py", line 109, in builder
    build(config, live_server=live_server, dirty=dirty)
  File "/Library/Python/2.7/site-packages/mkdocs/commands/build.py", line 282, in build
    build_pages(config, dirty=dirty)
  File "/Library/Python/2.7/site-packages/mkdocs/commands/build.py", line 242, in build_pages
    _build_page(page, config, site_navigation, env)
  File "/Library/Python/2.7/site-packages/mkdocs/commands/build.py", line 150, in _build_page
    template = env.get_template('main.html')
  File "/Library/Python/2.7/site-packages/jinja2/environment.py", line 830, in get_template
    return self._load_template(name, self.make_globals(globals))
  File "/Library/Python/2.7/site-packages/jinja2/environment.py", line 804, in _load_template
    template = self.loader.load(self, name, globals)
  File "/Library/Python/2.7/site-packages/jinja2/loaders.py", line 113, in load
    source, filename, uptodate = self.get_source(environment, name)
  File "/Library/Python/2.7/site-packages/jinja2/loaders.py", line 187, in get_source
    raise TemplateNotFound(template)
jinja2.exceptions.TemplateNotFound: main.html

Warnings with "flatly" theme

Building page documentation/systems/framework/UserObjects/ElementIntegralMaterialProperty.md
WARNING: Template variable warning: 'page_title' is being deprecated and will not be available in a future version. Use 'page.page_title' instead.
WARNING: Template variable warning: 'canonical_url' is being deprecated and will not be available in a future version. Use 'page.canonical_url' instead.
WARNING: Template variable warning: 'next_page' is being deprecated and will not be available in a future version. Use 'page.next_page' instead.
WARNING: Template variable warning: 'previous_page' is being deprecated and will not be available in a future version. Use 'page.previous_page' instead.
WARNING: Template variable warning: 'toc' is being deprecated and will not be available in a future version. Use 'page.toc' instead.
WARNING: Template variable warning: 'content' is being deprecated and will not be available in a future version. Use 'page.content' instead.
WARNING: Template variable warning: 'meta' is being deprecated and will not be available in a future version. Use 'page.meta' instead.

FYI. I have a custom logging formater, so it likely looks different than the default verbose output.

Warning when building with `united` theme

When I build my documentation with the united theme I get the following output.

INFO    -  Cleaning site directory 
INFO    -  Building documentation to directory: /home/tradr/tradr/ws/src/tradr-user-interaction/tradr_user_docs/site 
WARNING -  Your theme does not appear to contain a 'main.html' template. The 'base.html' template was used instead, which is deprecated. Update your theme so that the primary entry point is 'main.html'. 

Thanks for creating such a nice theme :)

Can't use themes, occurs configuration file warning.

what i did

$ pip install git+https://github.com/mkdocs/mkdocs-bootswatch.git@master
  # edit mkdocs.yml to use 'yeti' theme
$ mkdocs serve -a localhost:8009
INFO    -  Building documentation... 
WARNING -  The theme 'yeti' does not appear to have a configuration file. Please upgrade to a current version of the theme. 
INFO    -  Cleaning site directory 
[I 180227 13:17:31 server:283] Serving on http://localhost:8009
[I 180227 13:17:31 handlers:60] Start watching changes
[I 180227 13:17:31 handlers:62] Start detecting changes

what i expected

• it doesn't occurs WARNING about configuration file.
• mkdocs serves with theme 'yeti'

what i tried

$ pip install mkdocs-bootswatch
$ pip install mkdocs-bootswatch==0.5
$ pip install git+https://github.com/mkdocs/mkdocs-bootswatch.git@master

Any of above can't get mkdocs serve works without warning .

$ vim ~/.pyenv/versions/3.6.0/lib/python3.6/site-packages/mkdocs_bootswatch/yeti/mkdocs_theme.yml
 # copy from https://github.com/mkdocs/mkdocs-bootswatch/blob/master/mkdocs_bootswatch/yeti/mkdocs_theme.yml

it avoids the warning, but still 'yeti' theme is not applied.

environments

• OS
  • ProductName: Mac OS X
  • ProductVersion: 10.13.3
  • BuildVersion: 17D102
• Python
  • Python 3.6.0
  • pip 9.0.1
  • pyenv 1.2.1
  • mkdocs, version 0.17.2

Any ideas are appriciated!

Update to "new style" themes and automate generation

I would like to do this in my scarce free time. Are you using some kind of template to generate the entire family? If not, why?

UI horizontal scroll

Yeti and Cosmo themes have a blue header

I installed Mkdocs and Mkdocs Bootswatch on a new Ubuntu 18.04 machine and now when I build my site with the yeti theme the color scheme is different. The header bar is blue, when it should be dark grey.

It appears that css/bootstrap-custom.min.css is no longer being added to the page, and so the usual style overrides are not happening.

Could this be something I'm doing wrong? Or a bug in the Mkdocs/Bootswatch stack?

Feature request: add three level toc in left nav

Feature request: add three level toc in left nav

faulty active element in affix

Hello,
for me (chromium 48 and ff 44 on Ubuntu) the affix shows a wrong active element.
This can be seen on
http://mkdocs.github.io/mkdocs-bootswatch/#installation-usage
to.

TOC runs off the page for long documents

Originally reported against MkDocs. mkdocs/mkdocs#204

Sync upstream

mkdocs/mkdocs#549

Themes do not support admonitions

More context: mkdocs/mkdocs#811

Show more than first and second level heading in TOC

Is there any way to show more than just the first and second level headings in the table of contents in the upper left?
If so, which files need to be modified?

Thank you.

support China user

Can give some setting to replace google static file?

Block quotes are not working

I installed mkdocs-bootswatch and tried several of the sub-themes, but the citations / block-quotes are not showing up in the web browser. For example, the following md:

Hello, this is an example:

> And this is a citation

and this is a further paragraph.

results in the following:

In this example, I have used the yeti subtheme.

As a user, I would like instructions on to edit the themes

Hello,

I really liked the themes, and my company was looking at using these styles to do some proof-of-concept documentation before we can convert everything to this standard. However, as usual, people were questioning the colors. Go figure.

I was curious if I could get an explanation with how to change the themes colors and such. I have an extra-css file that Id like to use to keep everything easy for the rest of the team.

If I can get some insight, I would also like to contribute my experiences and a guide to the Wiki on here.

Permalink marker is always visible with Flatly/Amelia

The "permalink marker" ¶ (what do you call those things?) is always visible with Flatly/Amelia, looks terrible.

They're supposed to be visible only when you hover over the header.

Screenshots are broken on docs site.

It appears we are using absolute URLs rather than relative. And because the site is not at the server root, the absolute URLs are broken, whereas they would not be with the dev server.

Add config file

WARNING -  The theme 'yeti' does not appear to have a configuration file.

Please add an empty mkdocs_theme.yml as required:

A packaged theme is required to include a configuration file named mkdocs_theme.yml which is placed in the root of your template files. Th

release with docker image

Hello,
I have released bootswatch 0.4.0 as docker image. It's a pretty way ; )
https://hub.docker.com/r/pengbai/docker-mkdocs/

thanx and regards
Peng

[Q] Progressbar has border and padding with using "yeti theme".

Hello dev:

I use the yeti theme in https://bootswatch.com/yeti/

Then i write

<div class="progress">
  <div class="progress-bar bg-success" role="progressbar" style="width: 25%" aria-valuenow="25" aria-valuemin="0" aria-valuemax="100"></div>
</div>
<div class="progress">
  <div class="progress-bar bg-info" role="progressbar" style="width: 50%" aria-valuenow="50" aria-valuemin="0" aria-valuemax="100"></div>
</div>
<div class="progress">
  <div class="progress-bar bg-warning" role="progressbar" style="width: 75%" aria-valuenow="75" aria-valuemin="0" aria-valuemax="100"></div>
</div>
<div class="progress">
  <div class="progress-bar bg-danger" role="progressbar" style="width: 100%" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100"></div>
</div>

into my markdown file, and it looks like below:

not render like below in https://bootswatch.com/yeti/

Add new Bootswatch themes

Two (relatively) new Bootswatch themes:

http://bootswatch.com/paper/
http://bootswatch.com/sandstone/

http://news.bootswatch.com/post/94634387436/new-themes-paper-and-sandstone

Cannot use theme

Hi,

I got the below error when applying your theme.

➜  demo-doc mkdocs serve
INFO    -  Building documentation... 
WARNING -  The theme 'flatly' does not appear to have a configuration file. Please upgrade to a current version of the theme. 
INFO    -  Cleaning site directory 
ERROR   -  Error building page index.md

It looks like a compatible issue with mkdocs version. Any clues on how to fix this?

➜  demo-doc python --version
Python 3.6.1

➜  demo-doc pip freeze | grep -i mkdocs
mkdocs==0.17.2
mkdocs-bootstrap==0.1.1
mkdocs-bootswatch==0.4.0
mkdocs-windmill==0.1.2

Update to Bootswatch 4?

With MkDocs 1.1, the built-in mkdocs theme will use Bootswatch 4. We'll either need to update the themes here or stop deriving from the mkdocs theme. However, one complication is that the Amelia and Readable themes don't seem to exist in Bootswatch 4. What should we do with those? Just delete them? Trying to update the theme CSS seems like a lot of work...

@waylan Any thoughts? I did a proof of concept with one theme and it seemed fairly straightforward, so as long as we're ok with killing Amelia and Readable, this shouldn't be too bad. Plus, we'd be able to (relatively) easily add all the new Bootswatch themes to this project...

Load jquery at the top of themes

Hi! I'd like to propose these themes switch to loading jquery at the top of the page (or before user content is added) instead of at the bottom. This matches the behavior of the readthedocs theme.

This change would allow users to use jquery within their documents to spice things up, like many of the examples shown here http://bwmarrin.github.io/MkDocsPlus/

Please also see, bwmarrin/MkDocsPlus#2, mkdocs/mkdocs#956