MKdocs project documentation
-
wrote on May 28, 2019, 10:25 AM last edited by
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.
-
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.
wrote on Apr 19, 2020, 5:53 PM last edited by@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?
-
wrote on Apr 19, 2020, 5:57 PM last edited by
@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?
-
@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?
@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.
-
@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.
wrote on Dec 5, 2020, 2:25 AM last edited by vjvanjungg Dec 5, 2020, 2:46 AM@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!
-
@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!
wrote on Dec 5, 2020, 2:53 AM last edited by@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.
-
@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.
wrote on Dec 5, 2020, 2:59 AM last edited bythanks @robi! will test it there.
-
@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:
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.
-
@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.
wrote on Dec 5, 2020, 4:02 PM last edited by@fbartels thanks for sharing the process, i’ll have to play around with it some more. appreciate the thoughts/insights.
-
wrote on Dec 7, 2020, 12:16 AM last edited by
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
-
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
wrote on Dec 8, 2020, 6:46 AM last edited by@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
-
@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
wrote on Dec 8, 2020, 6:50 AM last edited by@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?
-
@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?
wrote on Dec 9, 2020, 4:43 AM last edited by@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?
-
@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?
wrote on Dec 9, 2020, 5:41 AM last edited by@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.
-
@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?
wrote on Dec 9, 2020, 6:04 AM last edited by@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.
-
@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.
wrote on Dec 10, 2020, 5:02 AM last edited by@atrilahiji gotcha, awesome awesome
i’ll try it , (think) i can do it now -
@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.
wrote on Dec 10, 2020, 6:35 AM last edited by@atrilahiji thank you!
