Using DocumenterVitePress as new documentation site#69
Open
Conversation
Member
Author
|
To run it locally, cd into docs, and run: It will install all dependencies found in the Then open a julia instance in the docs folder, activate the environment and run: include("make.jl")And in another terminal, run: Then you'll have a site that is served locally. |
Member
Author
|
The website is here: https://virtualplantlab.github.io/PlantSimEngine.jl/previews/PR69. |
asinghvi17
reviewed
May 17, 2024
asinghvi17
reviewed
May 17, 2024
asinghvi17
reviewed
May 17, 2024
|
If you're not deploying a custom theme via the Vitepress files, you can remove them + the package.json! |
Member
Author
|
Thank you for the review @asinghvi17! The website builds nicely locally, but it's not building properly on github pages, do you have any idea why? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See #60.
Also, remember that we can't merge before LuxDL/DocumenterVitepress.jl#38 is fixed. It will add documentation versioning, which is a required feature for me.
To do: