Comments (11)
From which file are trying to include content? You don't provide information nor a MRE. You want free support or not?
from mkdocs-include-markdown-plugin.
Would you mind to share a minimal reproducible example?
from mkdocs-include-markdown-plugin.
Hello!
Well I'll try)
Here's my mkdocs.yml
file:
# Project information
site_name: Koshelek documentation storage
site_url: https://developers.koshelek.app/
docs_dir: 'docs'
site_dir: 'site'
site_description: Koshelek API and integration documentation portal
theme:
name: material
language: ru
logo: assets/koshelekapi.png
custom_dir: docs/overrides
font:
text: Roboto
code: Roboto Mono
icon:
alternate: octicons/globe-16
features:
# - navigation.sections # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-sections
- navigation.indexes
- navigation.footer
- navigation.tracking
- navigation.expand
- navigation.top
extra_css:
- css/extra.css
- css/extra-swagger-ui.css
extra_javascript:
- javascripts/extra.js
Here's my file to include in the docs/includes folder (docs/includes/feedback_ru.md):
<!--feedback-start-->
<iframe src = "https://media.tinkoff.ru/polls/prod/poll-clfchftf3001g01kffdqe6j7f/index.html" height="300" width="400" style="border:none"></iframe>
<!--feedback-end-->
I try to include this content with example directive:
{%
include-markdown "docs/includes/feedback_ru.md "
start="<!--feedback-start-->"
end="<!--feedback-end-->"
%}
And all that I have is build errors...
from mkdocs-include-markdown-plugin.
And how is the files tree? Could you include a MRE, please? I would be able to help you much faster.
Apart from that, you're writing a whitespace at the end of the include path in your example. Well, obviously it won't work.
include-markdown "docs/includes/feedback_ru.md "
<--------------------------------------
from mkdocs-include-markdown-plugin.
The files tree (for example):
docs/
docs/assets/
docs/css/
docs/includes/
docs/javascripts/
docs/overrides/
docs/en/
docs/ru/
I'll specify one folder more precisely:
docs/ru/cm_pay_api/
... changelog.md
... specification.md
docs/ru/cm_pay_api/diagrams/
docs/ru/cm_pay_api/examples/
Something about this is stored in the docs/en/
folder. The docs/includes/
contains the file with content to include.
from mkdocs-include-markdown-plugin.
I can't reproduce it, could you provide a minimal reproducible example?
from mkdocs-include-markdown-plugin.
Well do you mean that all works fine on your side?
from mkdocs-include-markdown-plugin.
Well Alvaro, I'm trying to include content only from file docs/includes/feedback_ru.md
. It only contains the iframe
tag.
from mkdocs-include-markdown-plugin.
The includer file path, what is?
from mkdocs-include-markdown-plugin.
The problem appears in all files, you can put this include in any file (even if you create an empty one), so when I do this, I fail(
from mkdocs-include-markdown-plugin.
Okay, provide a proper MRE and I'll reopen this issue.
from mkdocs-include-markdown-plugin.
Related Issues (20)
- cant use variables inside template part HOT 2
- Exclude self from glob pattern HOT 1
- Is there a way to include markdown from a remote url? HOT 1
- FR: strict mode HOT 1
- TypeError: slugify() takes 0 positional arguments but 2 were given HOT 1
- Can `exclude` be a list? To exclude multiple different files? HOT 2
- Dash `-` is an invalid symbol within HTML templates HOT 9
- Is it necessary to set the "require_python" upper bound to <3.13 HOT 5
- pymdownx.tabbed breaks relative-url-rewrite for nested imports HOT 4
- WARNING log variables not binded HOT 1
- absolute URLs to include markdowns are sourced inside `docs/` HOT 4
- Include a table as part of a list item HOT 2
- Turn off comments by default
- This plugin doesn't seem to work with the `offline` plugin from MkDocs material HOT 3
- Unable to include content over SSL HOT 13
- Some clarification on heading_offset HOT 1
- pymdownx.tabbed is broken using mkdocs-include HOT 2
- Indented code blocks must be surrounded by blank lines
- How to get rid of <p></p> during include ? HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mkdocs-include-markdown-plugin.