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

Build vitepress directly without relying on package.json in writer #105

Merged
merged 2 commits into from
May 12, 2024

Conversation

asinghvi17
Copy link
Collaborator

@asinghvi17 asinghvi17 commented Apr 2, 2024

@lazarusA this should fix the Julia build

@asinghvi17 asinghvi17 changed the title Build vitepress directly without relying on package.json Build vitepress directly without relying on package.json in writer Apr 2, 2024
@asinghvi17 asinghvi17 closed this Apr 2, 2024
@asinghvi17 asinghvi17 reopened this Apr 2, 2024
@lazarusA
Copy link
Collaborator

lazarusA commented Apr 2, 2024

ohh.. this was not merged in the latest release. Testing this branch now.
Ohh my bad.

YES. I works!!!

@lazarusA
Copy link
Collaborator

lazarusA commented Apr 2, 2024

There is still something not right:

> docs:dev
> vitepress dev _build/html/en/.documenter

failed to start server. error:
Error: You need to install `markdown-it-mathjax3` to use math support.
    at createMarkdownRenderer (file:///Users/lalonso/node_modules/vitepress/dist/node/serve-BTRXZ1g2.js:37405:13)
    at async localSearchPlugin (file:///Users/lalonso/node_modules/vitepress/dist/node/serve-BTRXZ1g2.js:41795:14)
    at async createVitePressPlugin (file:///Users/lalonso/node_modules/vitepress/dist/node/serve-BTRXZ1g2.js:42426:5)
    at async createServer (file:///Users/lalonso/node_modules/vitepress/dist/node/serve-BTRXZ1g2.js:63811:14)
    at async createDevServer (file:///Users/lalonso/node_modules/vitepress/dist/node/cli.js:405:20)

@asinghvi17
Copy link
Collaborator Author

How did you run that last thing exactly?

@lazarusA
Copy link
Collaborator

lazarusA commented Apr 2, 2024

as it is: https://github.com/lazarusA/julia/tree/la/docs

in the root dir:

make docs

fails to build. I need to go into doc and do npm i first , and then

make docs

works.

and as usual in

doc> npm run docs:dev

to see the site.

@lazarusA
Copy link
Collaborator

lazarusA commented Apr 2, 2024

and if you want to test your branch (without the npm i step),

change line 9 in the make.jl file by

Pkg.add(PackageSpec(url="https://github.com/LuxDL/DocumenterVitepress.jl", rev="as/better_build"))

@asinghvi17
Copy link
Collaborator Author

huh. I'm like 90% sure we run npm i but maybe it's in the wrong place.

@lazarusA
Copy link
Collaborator

lazarusA commented Apr 3, 2024

yeah, npm i its ran internally. But for some reason when calling make docs it fails to do so. It only copies the packages.json file (if not available), but after that it's not doing the installation.

@asinghvi17
Copy link
Collaborator Author

I think the issue here is that it was probably using the wrong version of node or something, there were a bunch of recent issues about that.

@asinghvi17 asinghvi17 merged commit feeb4ba into master May 12, 2024
2 checks passed
thofma pushed a commit to thofma/DocumenterVitepress.jl that referenced this pull request May 19, 2024
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

Successfully merging this pull request may close these issues.

2 participants