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.

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

HTML in markdown failed to render #75

Open
takase1121 opened this issue Mar 17, 2019 · 8 comments
Open

HTML in markdown failed to render #75

takase1121 opened this issue Mar 17, 2019 · 8 comments
Labels
configuration revision Fixed or implemented. To be released.

Comments

@takase1121
Copy link

https://takase1121.github.io/Haruna/
The failed p and img tags are pretty obvious. Can I get them to work?

@onury
Copy link
Owner

onury commented Mar 18, 2019

Pls paste or attach your docma.json / config.

@takase1121
Copy link
Author

takase1121 commented Mar 18, 2019

{
    "src": [
        "./src/*.js",
        "./README.md"
    ],
    "dest": "./docs",
    "clean": true,
    "jsdoc": {
        "plugins": ["plugins/markdown"]
    },
    "app": {
        "title": "Haruna Documentation",
        "entrance": "content:readme",
        "base": "/Haruna",
        "routing": {
            "method": "path"
        }
    }
}

@onury
Copy link
Owner

onury commented Mar 19, 2019

Pls remove "plugins": ["plugins/markdown"] from your config. Docma includes a markdown parser.

@takase1121
Copy link
Author

The problem with HTML tag still persists. Not only that, If I disable jsdoc markdown plugin markdown in jsdoc is now ignored! Any ideas on how to fix it?

@onury
Copy link
Owner

onury commented Mar 19, 2019

Can you upload a sample project for me to reproduce the problem? I'll try to look into it tomorrow.

Just zip, then drag & drop here pls.

@onury onury reopened this Mar 19, 2019
@takase1121
Copy link
Author

Haruna.zip
This should be it. Thank you!

@takase1121
Copy link
Author

I got it! I turned markdown.sanitize to false in docma config and it worked!

@JRJurman
Copy link

I had to do this as well to get html in markdown to work. It says in the docs that it's by default set to false... Do the docs need to be updated?

@onury onury added revision Fixed or implemented. To be released. labels Jan 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
configuration revision Fixed or implemented. To be released.
Projects
None yet
Development

No branches or pull requests

3 participants