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

Docs are broken #1530

Closed
gordonwoodhull opened this issue Jun 19, 2019 · 3 comments
Closed

Docs are broken #1530

gordonwoodhull opened this issue Jun 19, 2019 · 3 comments
Assignees

Comments

@gordonwoodhull
Copy link
Contributor

I updated a ton of dependencies for #1508.

Then yesterday I got excited about a new example and published it.

Now the html docs seem to be completely broken.

@gordonwoodhull gordonwoodhull self-assigned this Jun 19, 2019
@gordonwoodhull
Copy link
Contributor Author

gordonwoodhull commented Jun 19, 2019

The one-page markdown docs are still okay

https://github.com/dc-js/dc.js/blob/develop/web/docs/api-latest.md

@gordonwoodhull
Copy link
Contributor Author

It's just the front page of the docs that is broken. jsdoc is attempting to wrap the <svg> in <p> tags, but it only gets the first line or two. So a mess of svg is inserted in an html context.

I've done a temporary fix manually. Maybe the svg needs to be inserted after jsdoc runs, since I can't expect it to understand what to do with 22K of svg.

IIRC the svg needs to be included directly in the page in order for links to work.

@gordonwoodhull
Copy link
Contributor Author

gordonwoodhull commented Jun 19, 2019

I'm too lazy to learn another grunt replace tool right now, so I fixed this by loading the svg dynamically and inserting it into the page using straight JS. Could revisit this if it causes problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant