Well, this is far from a minimal example, and I don't have access to the bitbucket branch, but what I'll say from what I can see in your project is that if you are running from the Documentation folder, you will have to use a
base_path setting that is relative to add the User folder to your path ../User. If you need access to both User and Documentation, you may have to use a relative path of .. and then reference your snippets via User/README.md and Documentation/README.md. The point is basically that you need to add the folder(s) to your base_path setting to get access to them. If you add multiple base_path locations that have files of the same name, it will use the first found, so be careful with your approach.
4 replies
I am the author of the Snippets package, and it should be able to work with relative paths. Had I been able to run the example you provided, I probably could have helped much more. A minimal reproducible example (only what is needed to reproduce the issue) usually helps such questions move along much faster. Unfortunately, I was not able to run your example as there were other things in the example that prevented me.
@facelessuser:matrix.org what's the progress on #4268? The issue has been pinned for 3 months now, does it still need input/awareness? Can we unpin it?
Unfortunately, I still don't think there's been nearly the input from the community as I hoped, but that is fine. I'm pushing to get an alpha out for the feature over the long holiday weekend. I have to finish updating unittests and write up some documentation. But functionality wise, I think it may be there. Some general life stuff got in the way, but I think we will be able to get it into people's hands very soon.
Personally, it would be nice to have awareness through the pre-release time, but it is up to you as to how long you'd like to pin the issue in Material.
Okay, thanks for the heads up. I'll close this issue now, and invite you to create a new issue when the alpha is out, ideally with some usage examples. I'll pin it again. If there's a use case that already works, we can also add it to the documentation to get more exposure (PR appreciated). That should hopefully raise some awareness. It's sad that not much feedback was received, but my experience is that authors will give feedback once they start using it. I guess during the pre-alpha stage, extension developers are more likely to give feedback than authors.
Also, many thanks for your work on this. I'll investigate the new capabilities once the alpha is out to build new components for Material for MkDocs.
The biggest thing I was hoping to get resolution on was syntax stuff. I was less concerned about API stuff at this point. Unfortunately, with the very small amount of participation, no clear consensus for the syntax directions could really be made, so we are just pushing ahead with what we have. There isn't an overwhelming slant towards either side with most of the things. During the alpha period, I will at least make clear the big points I'm hoping to get feedback on and we'll see if we get more conversation moving forward.
You will definitely get complaints on the syntax. No matter what you decide on.
You know how it is 😅
Yes, you can override the
header.html partial and add your buttons to the template. See our customization guide for how this can be done.
Making this configurable would introduce too much complexity, as use cases for buttons are very different. Some only want that a button points to a link, another user might want a button that adds functionality.
I am not sure if there is a issue im doing wrong but I cant seem to get the RSS to work properly with the blog plugin.
When I run the link via a RSS Validator and I get an error for the author name:
line 1, column 433: Invalid email address: zeren [help]
... Hello again world!</title> <author>zeren</author> <category>Bar</categor ...and also description error like this:
line 1, column 676: Missing channel element: description [help]
... n 2022 00:00:00 +0000</pubDate> </item> </channel></rss>
... and consult their documentation: https://guts.github.io/mkdocs-rss-plugin/
So I am pretty much done designing the layout for my Material with MkDocs documentation site but I have one final speedbump.
I would like to organize my content without having to make sure it's alphabetical or that I'm using number at the beginning of each thing.
I currently have the following working:
nav:
- Menu Header 1: <location>
- Menu Header 2: <location>
- Menu Header 3: <location>I am trying to get the sub drop-downs of each page and then the .md files inside each one organized in a custom ordering without using numbers and alphabetization.
Is there any way to achieve this? I have seen it done in other places but I can't seem to figure out the right formatting and I've looked through the docs to try and understand the formatting but can't find anything that show's what you do beyond the first level of menu headers.
This is an example of what I have tried to do in my mkdocs.yml to try and create the experience I want with .md files being out of order alphabetically.
nav:
- Menu Header 1: <location>
- Welcome.md
- Our Team.md
- Menu Header 2: <location>
- Forging a Path.md
- Apples Start Jouneys.md
- Menu Header 3: <location>
- Table Guide: <location>
- The Rule Book.md
- Showing your hand.md
- Create your Character: <location>
- Face.md
- Eyes.md
- Nose.md
- Hair.md
"Face, Eyes, Nose, and Hair" are not in alphabetical order here and they are inside of a "menu header 3" and then in the "Create your Character" drop-down.
When I run the code with my mkdocs.yml file like this it breaks and can't compile.
When I run the code with my mkdocs.yml file like this it breaks and can't compile.
Otherwise, if you want to put a page behind a section, see https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
But it's trivial to set up, see the page I just sent you.
They're doing it here, Tabs at the top out of alphabetical order and then drop downs with markdown files also out of alphabetical order.
Check out the plugin I linked above
Otherwise, creating a discussion on our discussion board might be a good idea, so other users can help you.
I have seen several problems and solutions in my time maintaining the project, but obviously not all 😁
In this example they are just using a hyphen followed by a name and the colon.
Then immediately afterwards they list pages and locations.
Does this only work if tabs are turned off? Or if everything is only a single layer deep?
Then immediately afterwards they list pages and locations.
Does this only work if tabs are turned off? Or if everything is only a single layer deep?
nav:
- Section:
- section/index.md
- Page 1: section/page-1.md
...
- Page n: section/page-n.md
Then click "New discussion".