GithubHelp home page GithubHelp logo

Comments (11)

mondeja avatar mondeja commented on June 30, 2024 1

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.

mondeja avatar mondeja commented on June 30, 2024

Would you mind to share a minimal reproducible example?

from mkdocs-include-markdown-plugin.

koshelekapi avatar koshelekapi commented on June 30, 2024

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.

mondeja avatar mondeja commented on June 30, 2024

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.

koshelekapi avatar koshelekapi commented on June 30, 2024

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.

mondeja avatar mondeja commented on June 30, 2024

I can't reproduce it, could you provide a minimal reproducible example?

from mkdocs-include-markdown-plugin.

koshelekapi avatar koshelekapi commented on June 30, 2024

Well do you mean that all works fine on your side?

from mkdocs-include-markdown-plugin.

koshelekapi avatar koshelekapi commented on June 30, 2024

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.

mondeja avatar mondeja commented on June 30, 2024

The includer file path, what is?

from mkdocs-include-markdown-plugin.

koshelekapi avatar koshelekapi commented on June 30, 2024

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.

mondeja avatar mondeja commented on June 30, 2024

Okay, provide a proper MRE and I'll reopen this issue.

from mkdocs-include-markdown-plugin.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.