SOLVED MKdocs project documentation
-
MKdocs
project documentation
https://www.mkdocs.org/It would be great to have a documentation app. Cloudron seems to be using it themselves already https://cloudron.io/documentation/ that shows quality
-
Hi @Enabl-ist,
the purpose of mkdocs is to locally create static pages which could be uploaded to your webserver (for example in Cloudron to the Lamp App, the "Surfer" app probably suffices as well). While mkdocs has a built-in server command, according to their docs this is for preview only.
-
As @fbartels already explained, mkdocs is really just a static docs generator and thus not exactly suitable as a Cloudron app as such. I will mark this as solved since mkdocs generated content already can be served up as explained above.
-
Hi @fbartels & @nebulon, thank you for your explanation. I will experiment with a wiki app to see if that will do.
Thanks!
-
@nebulon said in MKdocs project documentation:
mkdocs is really just a static docs generator and thus not exactly suitable as a Cloudron app as such. I will mark this as solved since mkdocs generated content already can be served up
But isn't that basically what GitHub Pages is too? And that's an app.
But either way, I'd love a step by step how to use mkdocs with Cloudron guide.
I get that step 1 is to upload files to eg surfer
And I'd guess step 2 may be too create Lamp App are the url one would like mkdocs to be at
And then install mkdocs docs on the Lamp app?
And then? How to tell it to use files on surfer? Etc
Even though the above may be relatively simple, it'd be even simpler if there was an app, no? Could perhaps be set up just like GitHub Pages app with its own repository?
-
@Enabl-ist said in MKdocs project documentation:
I will experiment with a wiki app to see if that will do.
I think this is evidence enough that lots of people like @Enabl-ist (and myself) would find it easier to just install a Cloudron app rather than working trying to out how to actually get mkdocs running (and kept up to date etc) on Cloudron themselves using eg surfer and lamp apps, no?
-
@jdaviescoates said in MKdocs project documentation:
I'd love a step by step how to use mkdocs with Cloudron guide.
Thats actually quite simple. I am using the following script to deploy my blog (built with Hugo, but mkdocs cannot be much different):
#!/bin/sh hugo && surfer put --token token-provided-by-surfer-app --server blog.9wd.eu public/. / exit 0You do not need the lamp app, surfer can directly host the files for you.
-
@fbartels may i ask along the lines of using surfer, when we upload the file index.html to the surfer app, then navigating to oursurferdomain.com will show whatever is on that file?
one more question if you don’t mind: your writing pad for the blog posts is from the code editor vscode in markdown style? i’m trying to figure out how this process connects works together. Thank you!
-
@vjvanjungg said in MKdocs project documentation:
may i ask along the lines of using surfer, when we upload the file index.html to the surfer app, then navigating to oursurferdomain.com will show whatever is on that file?
Yes, that is the purpose of Surfer.
Feel free to test it with the demo.cloudron.io instance.
-
thanks @robi! will test it there.
-
@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.
-
@fbartels thanks for sharing the process, i’ll have to play around with it some more. appreciate the thoughts/insights.
-
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!
-
Has anyone tried to push an MKDocs site from GitLab to a Cloudron app, either Surfer or the GitHub Pages app? I would love guidance on how to do that. It'd be great to manage the site on GitLab but have it push to Cloudron.
Thanks!
-
@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.
