MKdocs project documentation
-
@vjvanjungg said in MKdocs project documentation:
your writing pad for the blog posts is from the code editor vscode in markdown style?
While markdown syntax highlighting is nice, you could do this with any editor. I usually draft my texts in codimd (also hosted on my Cloudron). This makes it easy to add thoughts from multiple devices and share the text with others for review. Vscode comes in last when adding the file to my git repo and to make sure that the included spell checker is happy as well as markdownlint.
-
This is for a different Static Site Generator but I’ll just leave this here if you find it helpful: https://video.lahijiapps.dev/videos/watch/3540b0bb-553f-43bb-8087-fa8e26fd0d46
-
@atrilahiji
i did it!! thanks man, enjoyed it. 2 questions: how did you go from vscode to gitlab, or how did you go from github to gitlab, for future continuous updates?ps. heard your cat Meowww loudly at 17:23
-
@vjvanjungg Glad it helped! I'm not sure I quite understand your questions. Are you asking how I switched windows or how the experience is using VSCode and GitLab instead of Github?
-
@atrilahiji ah sorry i wasn’t being clear. I meant to ask, are you using any sort of extensions to push changes from Vscode straight to GitLab? Or... are you pushing the changes to GitHub, and then from GitHub to GitLab?
-
@vjvanjungg I just push directly to GitLab from VSCode or command line. As long as you clone the repo from GitLab you just git push and it goes right to GitLab.
-
@vjvanjungg Also to be more specific, I just used "git clone <gitlab repo URL>" to pull down the repo. Then when I opened the project in VSCode I just used its built in git management features.
-
@atrilahiji gotcha, awesome awesome
i’ll try it , (think) i can do it now -
@atrilahiji thank you!
-
-
@ntnsndr Yes, our docs.cloudron.io is a surfer instance. We deploy to that from a repo based on mkdocs. I don't have a guide for you, but https://git.cloudron.io/cloudron/docs is the repo and it has the gitlab-ci file. It simply deploys to docs.cloudron.io on each push.
Happy to answer any questions until we have better guide/docs for this.
-
@girish Thanks so much for this! Just what I needed. I'm working on creating an example repo that I can use for future. I think I fully de-cloudron-ed it... Am I right to leave in .gitlab-ci.yml this part?
default:
image: cloudron/docs-ci@sha256:4a63ad48a6fbbd168828769b0d796b511d09d173ab5dd64368338997164aa4abHere's the repo: https://gitlab.com/medlabboulder/docs
Let me know if there's anything else I should do. But for now it deploys!
-
@ntnsndr You are free to user our image (cloudron/docs-ci) but it was built from https://git.cloudron.io/cloudron/docs/-/blob/master/Dockerfile . You can of course build your own and push it as your user in docker hub. It's definitely better to do that in the unlikely case we change something in docker hub and it will end up affecting you.
