mkdocs / mkdocs-bootstrap Goto Github PK

View Code? Open in Web Editor NEW

77.0 77.0 38.0 1.32 MB

MkDocs Bootstrap Theme

Home Page: http://mkdocs.github.io/mkdocs-bootstrap/

License: BSD 2-Clause "Simplified" License

CSS 99.29% Python 0.71%

mkdocs-bootstrap's Introduction

MkDocs Bootstrap Theme

See the documentation for more details:

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

Release Notes

Version 1.1.1 (2023-07-28)

Fix issue with package distribution files (#32).

Version 1.1 (2020/02/22)

Update to support MkDocs version 1.1.
Update to support Bootstrap 4.

Version 1.0.1 (2018/10/01)

Include mkdocs_theme.yml in MANIFEST.

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.2 (2018/02/13)

Added support for MkDocs version 0.17 (#17).
Fixed use of Bootstrap Grid (#15).
Updated to FontAwesome 4.7.0 (#14).
Updated to Bootstrap 3.3.7 (#11).
Updated RespondJS and html5shiv (#9).

Version 0.1.1 (2015/06/23)

Initial release.

mkdocs-bootstrap's People

Contributors

Stargazers

Watchers

mkdocs-bootstrap's Issues

Error: The theme 'bootstrap' does not appear to have a configuration file.

gitlab-ci.log
Mkdocs is failing to build my site with the latest version of the mkdocs-bootstrap theme.

I suggest adding *.yml to the MANIFEST.in, in order to make sure mkdocs_theme.yml gets included in the release.

diff --git a/MANIFEST.in b/MANIFEST.in
index 9993b1f..cc6f29f 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,3 @@
-recursive-include mkdocs_bootstrap *.ico *.js *.css *.png *.html *.eot *.svg *.ttf *.woff *.woff2
+recursive-include mkdocs_bootstrap *.ico *.js *.css *.png *.html *.eot *.svg *.ttf *.woff *.woff2 *.yml
recursive-exclude * __pycache__
recursive-exclude * *.py[co]

Bootstrap still using 3.x version

When installing using pip bootstrap version shown is 3.x while in github it is showing 4.

TOC runs off the page for long documents

Originally reported against MkDocs. mkdocs/mkdocs#204

Add mkdocs_theme.yml for 0.17.x support

mkdocs v0.17 added a required mkdocs_theme.yml file. Without the file present the template causes the build to fail.

This config file should be added to mkdocs-bootstrap to allow the theme to work with the latest mkdocs release.

Version 1.1 wheel package distribution is broken

I think that the released 1.1 version have a broken wheel package.

Bug

Only with those command

$ mkdocs new website
$ mkdocs build

When you open the website, you can observe a big white space between the top of the screen and the top menu.

Primary cause

After some investigation, I found that the version 1.1 use bootstrap version 4 but if you install wheel package, it will generate an index.html like this :

<link href="css/bootstrap-3.3.7.min.css" rel="stylesheet">
<script src="js/bootstrap-3.3.7.min.js" defer></script>

With those files :

css/bootstrap.min.css
css/bootstrap-3.3.7.min.css
js/bootstrap-3.3.7.min.js
js/bootstrap.min.js

Root cause

If look for bootstrap files inside mkdocs-bootstrap-1.1.tar.gz and mkdocs_bootstrap-1.1-py2.py3-none-any.whl, you will be surprised

_	`.tar.gz`	`.whl`
css/bootstrap.min.css	present
css/bootstrap-3.3.7.min.cs		present
js/bootstrap-3.3.7.min.js	present	present
grep bootstrap main.html	`bootstrap-3.3.7.min.js`	`bootstrap.min.js`

A workaround

When installing theme the flag --no-binary :all: can be used. This permit to use the not bugged .tar.gz file.

A way to fix the problem

You can maybe create a new version 1.1.1 with a fixed wheel package.
I think that override the 1.1 version is a bad thing because local mirroring software will may not download a new file with the same version number.

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

Sync upstream

mkdocs/mkdocs#549
mkdocs/mkdocs@a88b054

CVE-2018-14041: Cross-Site Scripting (XSS) in Bootstrap 3.3.7 - Upgrade to Bootstrap 4.1.3

In Bootstrap before 4.1.2, XSS is possible in the data-target property of scrollspy.

https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-14041

site_name: Test
site_description: Test Bootstrap Theme
site_author: Anonymous
theme:
  name: bootstrap
  shortcuts:
    help: 191    # ?
    next: 78     # n
    previous: 80 # p
    search: 83   # s

The resulting navigation of the theme is hard to use because the text is blue on blue:

Any ideas why that might be happening? Thanks!

Font files missing

Installation via

pip install mkdocs

using standard theme which is bootstrap theme

URL        `../fonts/glyphicons-halflings-regular.eot'
Parent URL http://127.0.0.1:8000/css/bootstrap-custom.min.css, line 1, col 36239
Real URL   http://127.0.0.1:8000/fonts/glyphicons-halflings-regular.eot
Check time 3.413 seconds
Result     Error: 404 File not found

URL        `../fonts/glyphicons-halflings-regular.eot?#iefix'
Parent URL http://127.0.0.1:8000/css/bootstrap-custom.min.css, line 1, col 36292
Real URL   http://127.0.0.1:8000/fonts/glyphicons-halflings-regular.eot#iefix
Check time 3.466 seconds
Result     Error: 404 File not found

URL        `../fonts/glyphicons-halflings-regular.woff'
Parent URL http://127.0.0.1:8000/css/bootstrap-custom.min.css, line 1, col 36376
Real URL   http://127.0.0.1:8000/fonts/glyphicons-halflings-regular.woff
Check time 3.551 seconds
Result     Error: 404 File not found

URL        `../fonts/glyphicons-halflings-regular.ttf'
Parent URL http://127.0.0.1:8000/css/bootstrap-custom.min.css, line 1, col 36441
Real URL   http://127.0.0.1:8000/fonts/glyphicons-halflings-regular.ttf
Check time 3.218 seconds
Result     Error: 404 File not found

URL        `../fonts/glyphicons-halflings-regular.svg#glyphicons-halflingsregular'
Parent URL http://127.0.0.1:8000/css/bootstrap-custom.min.css, line 1, col 36509
Real URL   http://127.0.0.1:8000/fonts/glyphicons-halflings-regular.svg#glyphicons-halflingsregular
Check time 3.062 seconds
Result     Error: 404 File not found

So looks like many font files are missing.
Please correct

Issue raised earlier at mkdocs/mkdocs#894 (comment) and was redirected here.

The theme can't be used?

Python 2.7.13
mkdocs, version 0.17.2
mkdocs-bootstrap 0.1.1

site_description: knowledge Document
theme: bootstrap

then I use mkdocs serve , will report an error below

INFO    -  Building documentation... 
WARNING -  The theme 'bootstrap' 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 
Traceback (most recent call last):
  File "/usr/local/bin/mkdocs", line 11, in <module>
    sys.exit(cli())
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 722, in __call__
    return self.main(*args, **kwargs)
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 697, in main
    rv = self.invoke(ctx)
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 1066, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 895, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/local/lib/python2.7/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "/usr/local/lib/python2.7/site-packages/mkdocs/__main__.py", line 127, in serve_command
    livereload=livereload
  File "/usr/local/lib/python2.7/site-packages/mkdocs/commands/serve.py", line 117, in serve
    config = builder()
  File "/usr/local/lib/python2.7/site-packages/mkdocs/commands/serve.py", line 112, in builder
    build(config, live_server=live_server, dirty=dirty)
  File "/usr/local/lib/python2.7/site-packages/mkdocs/commands/build.py", line 282, in build
    build_pages(config, dirty=dirty)
  File "/usr/local/lib/python2.7/site-packages/mkdocs/commands/build.py", line 242, in build_pages
    _build_page(page, config, site_navigation, env)
  File "/usr/local/lib/python2.7/site-packages/mkdocs/commands/build.py", line 150, in _build_page
    template = env.get_template('main.html')
  File "/usr/local/lib/python2.7/site-packages/jinja2/environment.py", line 830, in get_template
    return self._load_template(name, self.make_globals(globals))
  File "/usr/local/lib/python2.7/site-packages/jinja2/environment.py", line 804, in _load_template
    template = self.loader.load(self, name, globals)
  File "/usr/local/lib/python2.7/site-packages/jinja2/loaders.py", line 113, in load
    source, filename, uptodate = self.get_source(environment, name)
  File "/usr/local/lib/python2.7/site-packages/jinja2/loaders.py", line 187, in get_source
    raise TemplateNotFound(template)
jinja2.exceptions.TemplateNotFound: main.html

Missing tag for 1.1.1

Please push the tag for 1.1.1 release to GitHub.

Bootstrap - Navigation - menus - multple rows - overlaps content

See original issue: mkdocs/mkdocs#210

mkdocs / mkdocs-bootstrap Goto Github PK

mkdocs-bootstrap's Introduction

MkDocs Bootstrap Theme

Release Notes

Version 1.1.1 (2023-07-28)

Version 1.1 (2020/02/22)

Version 1.0.1 (2018/10/01)

Version 1.0 (2018/08/03)

Version 0.2 (2018/02/13)

Version 0.1.1 (2015/06/23)

mkdocs-bootstrap's People

Contributors

Stargazers

Watchers

Forkers

mkdocs-bootstrap's Issues

Bug

Primary cause

Root cause

A workaround

A way to fix the problem

Recommend Projects

Recommend Topics

Recommend Org