gristlabs / mkdocs-windmill Goto Github PK
View Code? Open in Web Editor NEWOutstanding mkdocs theme with a focus on navigation and usability
License: Other
Outstanding mkdocs theme with a focus on navigation and usability
License: Other
Makes sense that a theme actually shows what it will look like to allow users make a decision
Hello guys, nice theme btw
I am trying to build the menu. The problem is the menu item that points to the index.md file generated without anchor tag, so the menu item that is associated with it, is not clickable.
My mkdocs.yml:
site_name: some site
theme: 'windmill'
nav:
- Introduction: 'index.md'
- Purpose of the system design document : 'purpose of the system design document.md'
- General overview and design guidelines/approach:
- General overview : 'general overview.md'
- Assumptions/Constraints:
- Assumptions: 'assumptions.md'
- Constraints: 'constraints.md'
- Desing considerations:
- Goals: 'goals.md'
- Dependencies: 'dependencies.md'
- Overall system architecture:
- Functional architecture:
- UAE pass mobile app : 'uae pass mobile app.md'
- UAE pass self-service portal: 'uae pass self-service portal.md'
- Infrastructure architecture: 'infrastructure architecture.md'
- Network architecture : 'network architecture.md'
- Security architecture : 'security architecture.md'
- Operational scenarios:
- User enrolments : 'user enrolments.md'
- Auth : 'auth.md'
- Change email/mobile : 'change email-mobile.md'
- User profile management: 'user profile management.md'
- Notifications: 'notifications.md'
- Google Drive and Dropbox integration : 'google drive and dropbox integration.md'
- Databases design: 'database design.md'
- Interfaces UX/UI: 'interfaces.md'
- Acronyms and Abbreviations: 'acronyms and abbreviations.md'
Every other menu or menu item works correctly except the "Introduciton"
During search,the url adds "." after # in the url
For eg. after searching the url would be something like "http://127.0.0.1:8000/#.widgets/alert" instead of
"http://127.0.0.1:8000/#widgets/alert
Previous and next keeps adding to the url instead of clearing it first.
For eg. Before clicking,url would be something like "http://127.0.0.1:8000/#widgets/alert",
after clicking next, url would be "http://127.0.0.1:8000/#widgets/alert/widgets/accordion" instead of
"http://127.0.0.1:8000/#widgets/accordion"
when mkdocs.yml contains
use_directory_urls: false
If ampersands are part of a menu item, they are escaped and displayed as &
instead of &
. When the same item is displayed in the document text, ampersands are rendered fine as &
.
Can you please provide some directions on how to enable multi-version drop-down selector instead of version subtitle?
I was going over this suggestion - squidfunk/mkdocs-material#770 (comment), but not exactly sure how to apply it on a windmill
.
Thanks!
I would like to extend this theme to include Google Tag Manager and I'd like to mirror how mkdocs-material did it:
squidfunk/mkdocs-material#2055
Before I submit a PR I wanted to confirm that this repo was still being actively monitored. Thanks.
From some applications (e.g. Gmail and Slack OSX Desktop app), anchors on the home page are broken.
This is because they turn two consecutive hashes (##
) into the second one url-escaped (#%23
).
E.g., if you paste this into slack app or send in gmail, then click it:
https://mysite.com/##header
You get sent to this page (which obviously 404s):
https://mysite.com/#%23header
This only happens on the root page (which is the only one with consecutive hashes in the URL), so one solution would be to use mysite/#/
(with a trailing slash) as the root, instead of just mysite/#
. However, this seems to work on real sites (served via nginx), but not when served locally via mkdocs serve
.
Thanks for a theme with such an awesome navigation!
It seems highlightjs parameters (such as hljs_style
and hljs_languages
) are not respected in Windmill despite being fully supported in mkdocs. I.e. following code works fine with mkdocs but not with name: windmill
:
theme:
name: mkdocs
highlightjs: true
hljs_style: 'atelier-sulphurpool-light'
hljs_languages:
- protobuf
The TOC navigation has a small glitch: the title that is selected hides behind the top banner. For instance when I select the page Workflow, the title is displayed properly.
But when I click on Digitization Workflow, most of the title disappears behind the banner.
Is that a problem you experience too? Is there something to do about it?
Hello! Love the windmill theme.
One bug I noticed:
In Markdown, I type:
- list
- a
- b
- next list
- c
When rendered into my wiki, there is more space between - list
and - a
than there is between - b
and - next list
. Which doesn't seem right. It throws off the look when you are trying to show organization and the separation (if any) should be between - b
and - next list
.
In the windmill theme, try writing a page containing the following code block:
```sh
git clone https://github.com/gristlabs/mkdocs-windmill.git
```
It will ignore the language specification and attempt to guess the language instead, probably arriving at some conclusion like "vim" and highlighting the s:
in the URL blue (!).
For two years, mkdocs has supported disabling highlight.js, which is great because highlight.js insists on guessing the code language, ignoring the user's explicit direction, and guesses something silly, as in the example above. In all built-in mkdocs themes, you can do:
theme:
highlightjs: false
markdown_extensions:
- codehilite
extra_css:
- css/code_styles.css
Please add support for this to windmill.
To see how mkdocs did it for their themes, check out, for example, this PR.
Thanks!
if I use the theme and do 'mkdocs serve' everything looks and acts great:.
but if I do 'mkdocs build' then trying to access that same page results in the following:
The image above was taken from our QWebEngine based html viewer (Basically Chrome). If I try the same site within Safari then the enclosing folder of the index.html file is opened up.
I use the "material" theme or the "mkdocs" theme I do not have these issues.
I like your theme because we have a large documentation project and the permanent navigation on the left side is extremely useful for navigation.
I'm using your theme to build a documentation site on Tibetan NLP in Tibetan. I've opted to download the theme folder from github, but somehow the search doesn't build properly and the search bar doesn't scale properly on my mobile. My project is here.
Thanks a lot for building this theme! It's going to be great.
Hi, I recently installed the windmill package as my theme. On chrome it works just fine although a pointer on how to decrease the width of the page so that the text and everything doesn't seem so small would be helpful. But on ie the first page doesn't open up the content. And then when you click on anything in navigation after going to the page you clicked the navigation bar disappears completely. Any ideas on how to fix?
Thanks.
Another minor issue I noticed is that when I type a heading that is too long (they are nested within other headings btw) the window resize makes the navigation window on the left larger and spill out onto the notes section of the pages.
Example:
in a .md file, I use a very long heading:
## Very extremely super duper longish but pretty long heading
I'm using Chrome on a fairly new Macbook Pro 13"
After reading the Customization and the Customizing a Theme, I can't figure out how to define the extra
parameters on the mkdocs.yml
.
What I've tried so far:
theme: windmill
extra:
- extra.logo: 'img/Logo-128.png'
theme: windmill
extra:
extra.logo: 'img/Logo-128.png'
The error messages are
The configuration is invalid. The expected type was a key value mapping (a python dict) but we got an object of type: <type 'NoneType'>
The configuration is invalid. The expected type was a key value mapping (a python dict) but we got an object of type: <type 'NoneType'>
Could you please provide an example for the extra
customisation options? Thank you!
Hello,
I really like this theme, but I found a major issue for me: the mkdocs metadata are not accessible for pages except for the main page.
I am using windmill theme for mkdocs to generate static webpages. Good news is everything works charm as expected however I have an issue with search option.
When I search for any resources the url is changed to http://#.
Please notice a dot(.) between domain and key which is causing the problem. When I checked search.html, I could see key is present without dot(.) which is correct
Wondering where an extra dot(.) is getting appended during the search. Any leads on this issue would be highly appreciated
PS: I do not have any fancy configurations in mkdocs.yaml and I have kept very basic
Regards,
Karthik
Would be nice to have one.
Hi,
I am trying to have a menu links in the sidebar where i can just given an url to html file!
I know it can be done with
nav:
- Test: "http://example.com"
But i am not using nav at all!
I have
theme:
name: null
custom_dir: theme
search_index_only: true
include_search_page: true
And it takes the folder structure automatically! if i will use nav, it override my current folder structure!
Please consider adding the bootstrap.min.css.map
file from the standard Bootstrap distribution to the theme CSS directory. It seems to be used when examining rendered pages in developer mode.
It does everything I want! Thanks for making and sharing it! 🥇 👍 ❤️
Hi,
I am new to mkdocs, and i wanted to know is there any way to change the ordering of the menu title and the anchor in the global navigation menu?
Thank you.
This behavior seems to have been introduced since v0.1.2
It would be nice to distinguish header levels in the menu, at least for H1-H3, by different indentation levels or styling.
Any interest in a PR to support this?
Thanks,
-- Chad
Hello,
I know not everyone will need this, but it would be nice to go to lvl4 on left menu.
You just need to add it in base.css:
.wm-toc-lev1 > .wm-toc-text { padding-left: 14px; }
.wm-toc-lev2 > .wm-toc-text { padding-left: 28px; }
.wm-toc-lev3 > .wm-toc-text { padding-left: 42px; }
.wm-toc-lev4 > .wm-toc-text { padding-left: 56px; }
.wm-toc-lev1 + .wm-page-toc { margin-left: 14px; }
.wm-toc-lev2 + .wm-page-toc { margin-left: 28px; }
.wm-toc-lev3 + .wm-page-toc { margin-left: 42px; }
.wm-toc-lev4 + .wm-page-toc { margin-left: 56px; }
And it works like a charm :-)
And by the way, many thanks for this Theme, it's perfect !
Ox
Hi,
I followed the install instructions and I am using the development server (mkdocs serve) without extra configuration besides your theme:
site_name: My Site
theme: windmill
When I do I search I get the default theme style without highlighting. But if I click twice on the search box then the highlight appears. Also when I click on SEE ALL RESULTS http://localhost:8000/#search.html?q=test I get a 404 for that page.
Do I need to setup anything else for the search to work correctly ?
Thanks,
Claudio.
I am using MkDocs with the Windmill theme for a new site. I have a Docker container running a development server during development, then I use Travis CI from GitHub to build the actual site into GitHub Pages. In both places, which use the most recent version of mkdocs-windmill available to pip, I get a warning:
WARNING - The theme 'windmill' does not appear to have a configuration file. Please upgrade to a current version of the theme.
Looking at the MkDocs source code, it appears to be looking for a mkdocs_theme.yml
file. Could you provide one to prevent the warning?
This is not an issue but, how can I change the content frame size to use the entire screen.
I'm using Full HD (10920x1080) and there's too much empty screen.
The Ivory Theme, for example uses the entire frame to display the content.
I love the Windmill Theme!
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.