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

Migration of Documentation from Documenter to DocumenterVitepress #13

Merged
merged 1 commit into from
Jun 4, 2024

Conversation

divital-coder
Copy link
Contributor

@divital-coder divital-coder commented Jun 4, 2024

Skipped online deployment for docs due to package being outdated in the reigstry
To run documentation locally :
If u want to run the docs until the MedEval3D package is not updated in the registry,
clone the MedEval3D
and make it available in ur environment by

git clone https://github.com/JuliaHealth/MedEval3D.jl
cd MedEval3D.jl
julia
]
develop ./
backspace 
using MedEval3D

Exit out of julia and do the following in ur terminal

cd MedEye3d.jl
julia
]
develop ./
backspace
using MedEye3d
cd("docs")
]
activate .
backspace
include("make.jl")
hit ; (enter shell mode)
npm i
backspace
DocumenterVitepress.dev_docs("build")

@divital-coder
Copy link
Contributor Author

Please open a branch named gh-pages on here :)

@jakubMitura14 jakubMitura14 merged commit 9a18c71 into JuliaHealth:master Jun 4, 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.

3 participants