-
Notifications
You must be signed in to change notification settings - Fork 11.9k
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
Switch docs to Vuepress to match other chart.js repositories #8751
Conversation
Tests deployment (without the conditional base): https://9b316917.chart-js.pages.dev/ |
Maby its a good idea to remove links to hardcoded lines in the source files since if you add/remove lines there you will have to update that in the docs too. For example the link to the core animations default is now a few lines short (https://9b316917.chart-js.pages.dev/configuration/animations.html#animation) or the Link in the plugin core api (https://9b316917.chart-js.pages.dev/developers/plugins.html#plugin-core-api) is wrong now (was done this way as temp fix because the list was removed from v2 -> v3 docs) |
Good call @LeeLenaleee. I removed those. For the plugins, https://www.npmjs.com/package/vuepress-plugin-typedoc seems promising to get the typedocs working and we can try and build them from the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
@etimberg @kurkle When I try to build the docs locally (as dev and as a real static build) it gives me a basic html only page with only the md file as content. The same error is happening with the deploy at the moment (https://www.chartjs.org/docs/master/) |
@LeeLenaleee what node version are you using locally? |
12.16.2, after updating to the latest LTS (14.16.0) resolved the issue for me, although it seems like the master docs is still broken even though you made it build with node 14 now |
I think its a combination of GitHub pages + Cloudflare caching at this point. I got the broke page once and it loaded the old style file, |
@kurkle found that if we go to https://www.chartjs.org/docs/master/getting-started/ it works, so seems like the old index page got cached |
Work Done
vuepress-theme-chartjs
pluginTesting Done
npm run docs:dev
deploy-docs
action locally all the way until it pushes to GitHub pagesResolves #5712