Skip to content

Commit 7d490da

Browse files
author
neatc0der
committed
#35: Extends readme to cover troubleshooting
1 parent f32d263 commit 7d490da

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,29 @@ extra_javascript:
9292
* `markmap-lib`
9393
* `markmap-view`
9494
95-
9695
## Troubleshooting
9796
9897
### Nav tree lists markmaps
9998
10099
1. Move your markmap files to a separate folder next to `docs`, e.g. `mindmaps`
101100
2. Configure `base_path` accordingly (see [Advanced Settings](#advanced-settings))
102101
102+
### Static javascript files not working
103+
104+
1. Ensure naming of javascript files matches the scheme (see [Advanced Settings](#advanced-settings))
105+
2. Copy all javascript files to `doc/js/`, otherwise `mkdocs` will not copy static files to `site/`
106+
3. Define all files in `extra_javascript`, e.g.
107+
108+
```yaml
109+
extra_javascript:
110+
- js/markmap-d3.js
111+
- js/markmap-lib.js
112+
- js/markmap-view.js
113+
```
114+
115+
### Usage of proxy is prevent download of javascript files
116+
117+
Usually proxies should be supported by `requests`, which is used for downloading all required javascript files. If the issue remains, try downloading the files yourself and store them accordingly (see [Static javascript files not working](#static-javascript-files-not-working))
103118
104119
## Credits :clap:
105120

0 commit comments

Comments
 (0)