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

Follow instructions in DocumenterVitepress.jl readme #10

Closed
wants to merge 20 commits into from

Conversation

LilithHafner
Copy link
Owner

Follow instructions in DocumenterVitepress.jl readme to switch frontend to Vitepress

@LilithHafner
Copy link
Owner Author

The new website is not viable compared to the current Documenter.jl site

@asinghvi17
Copy link

Ah no, as of now you'd have to copy the entire make.jl over since it's using NPM to build the site. I am currently working on that and a PR should be out in 10 minutes or so.

@asinghvi17
Copy link

hmm it doesn't look like CI triggered somehow

@LilithHafner
Copy link
Owner Author

LilithHafner commented Feb 23, 2024

CI is (mis)configured to not abort previous runs on push to a PR. CI has now run.

EDIT: fixed in #16

@asinghvi17
Copy link

error fixed in LuxDL/DocumenterVitepress.jl#32 - you can set build = joinpath(@__DIR__, build) in makedocs for now though

@asinghvi17
Copy link

asinghvi17 commented Feb 23, 2024

Ah you didn't add package.json to the docs...I guess we could handle this in makedocs as well? But for right now you should upload package.json and package-lock.json from DocumenterVitepress.jl/docs/.

@LilithHafner
Copy link
Owner Author

LilithHafner commented Feb 24, 2024

Yay! It builds!

A couple of issues still:

  • The page is slightly better formatted than after b8fffba, but still nowhere near https://luxdl.github.io/DocumenterVitepress.jl/dev/. I suspect some style information is missing
  • This PR adds 3000loc, which would quadruple the size of this repo, I'd like to avoid that. Auto-generating docs/package-lock.json and docs/package.json in makedocs would be nice.

@asinghvi17
Copy link

ah damn, I know why that's happening. Vitepress needs correct deployment information and I did not check your domain name beforehand. This will just need another option in the config, so that's fine.

You can definitely remove package_lock.json (I think) and you should be able to remove package.json as well after v0.0.4 is released, hopefully tonight.

Thanks for uncovering all these issues, by the way! It's something I hadn't thought of but in hindsight using subdomain.mydomain.com is pretty common so I should probably support that.

@LilithHafner
Copy link
Owner Author

Wow! 0.0.4 is quite a low version number. Thanks for all the help getting this working :)

@LilithHafner
Copy link
Owner Author

DocumenterVitepress 0.0.5 fixed the not-building issue, but the formatting at https://chairmarks.lilithhafner.com/previews/PR10/ is still broken.

@asinghvi17
Copy link

Folder looks like: ["404.html", "assets", "hashmap.json", "index.html"]
meaning something is still going wrong here - this folder structure means that Vitepress did not detect any markdown files.

I'll clone this PR locally and see what's going on - this is a bit strange!

docs/make.jl Outdated
devbranch = "main",
devurl = "dev",
deploy_url = "chairmarks.lilithhafner.com",
build_vitepress = false,
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The site is currently a 404 error, likely because there is not index.html or such at https://github.com/LilithHafner/Chairmarks.jl/tree/gh-pages/previews/PR10.

Maybe this will help?

Suggested change
build_vitepress = false,

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep! This fixes the 404 error, but the formatting is still broken.

@LilithHafner
Copy link
Owner Author

The readme instructions have changed and many of the issues I reported while working on this PR are fixed. I'm going to try again.

@LilithHafner LilithHafner deleted the lh/docs-vitepress branch March 2, 2024 12:57
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