Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Changelog doc rendering error due to the removing of include-markdown plugin #186

Closed
shenxiangzhuang opened this issue Oct 25, 2023 · 3 comments
Closed

Changelog doc rendering error due to the removing of include-markdown plugin #186

shenxiangzhuang opened this issue Oct 25, 2023 · 3 comments
Labels
bug Something isn't working solved The issue has been satisfactorily solved

Comments

@shenxiangzhuang
Copy link

shenxiangzhuang commented Oct 25, 2023 •
edited by fralau
Loading

After remove the include-markdown plugin, the CHANGELOG.md is broken in the web documentation.
@github-actions
Copy link

Welcome to this project and thank you!' first issue

@shenxiangzhuang shenxiangzhuang mentioned this issue Oct 25, 2023
Closed
@fralau fralau added the bug Something isn't working label Oct 25, 2023
@fralau fralau linked a pull request Oct 25, 2023 that will close this issue
Fixed:doc:changelog #185
Closed
@fralau
Copy link
Owner

fralau commented Oct 25, 2023

Removing include-markdown was an emergency measure, because mkdocs build was crashing after adding mkdocs-mermaid2 (and therefore readthedocs).

It might be better to try and solve that issue directly, before trying another solution?

fralau pushed a commit that referenced this issue Oct 31, 2023
Fix issue with changelog no longer displayed (#186)
4bfda0b 
  - It was a problem with include-markdown directive,
    between doc examples and the 'real' include of the changelog;
    solved it by changing the syntax of the 'real' include.
  - Updated changelog
  - Bumped version number
@fralau fralau added the solved The issue has been satisfactorily solved label Oct 31, 2023
@fralau
Copy link
Owner

fralau commented Oct 31, 2023 •
edited
Loading

Problem solved, by changing the syntax of "real" includes. Available on version 1.0.5.

@fralau fralau closed this as completed Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working solved The issue has been satisfactorily solved
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixed:doc:changelog shenxiangzhuang/mkdocs_macros_plugin
2 participants
@shenxiangzhuang @fralau