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.

Sign up for GitHub

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

Jump to bottom

docs template #9

Merged

LorenzLamm merged 2 commits into main from docs-template

Jun 6, 2023

Contributor

alisterburt commented May 16, 2023

Hey @LorenzLamm

So great to see you pushing this again - in this PR you have all that you need to work on documentation, I'm using mkdocs-material

basics:

pip install mkdocs-material
write markdown in docs folder
if you add images, put them in comments on a github issue and reference the URL of that uploaded image
mkdocs serve in the repo root for local preview
there is a github action for deployment to GitHub pages which will make the site available at teamtomo.org/membrain-seg

Please feel free to merge this PR and iterate, editing an existing thing is always much easier than starting from scratch :)

alisterburt added 2 commits

May 16, 2023 18:25


          docs template

e286c49


          adjust basic site metadata

ffa08f2

LorenzLamm merged commit 01cc054 into main

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet