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

Using DocumenterVitePress as new documentation site #69

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

VEZY
Copy link
Member

@VEZY VEZY commented Apr 11, 2024

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:

@VEZY
Copy link
Member Author

VEZY commented Apr 11, 2024

To run it locally, cd into docs, and run:

npm i

It will install all dependencies found in the package.json file.

Then open a julia instance in the docs folder, activate the environment and run:

include("make.jl")

And in another terminal, run:

npm run docs:dev

Then you'll have a site that is served locally.

@VEZY
Copy link
Member Author

VEZY commented Apr 12, 2024

The website is here: https://virtualplantlab.github.io/PlantSimEngine.jl/previews/PR69.
Although it builds fine locally, the build on GA is faulty and needs to be checked.

docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
@asinghvi17
Copy link

If you're not deploying a custom theme via the Vitepress files, you can remove them + the package.json!

@VEZY
Copy link
Member Author

VEZY commented May 17, 2024

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?

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