Cloudron makes it easy to run web apps like WordPress, Nextcloud, GitLab on your server. Find out more or install now.


    Cloudron Forum

    • Register
    • Login
    • Search
    • Categories
    • Recent
    • Tags
    • Popular

    Solved MKdocs project documentation

    App Wishlist
    9
    24
    1211
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • Enabl.ist
      Enabl.ist 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 ๐Ÿ™‚

      1 Reply Last reply Reply Quote 2
      • fbartels
        fbartels App Dev last edited by

        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.

        1 Reply Last reply Reply Quote 0
        • nebulon
          nebulon Staff last edited by

          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.

          jdaviescoates 1 Reply Last reply Reply Quote 1
          • Enabl.ist
            Enabl.ist last edited by

            Hi @fbartels & @nebulon, thank you for your explanation. I will experiment with a wiki app to see if that will do.

            Thanks!

            jdaviescoates 1 Reply Last reply Reply Quote 0
            • jdaviescoates
              jdaviescoates @nebulon 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?

              I use Cloudron with Gandi & Hetzner

              fbartels 1 Reply Last reply Reply Quote 0
              • jdaviescoates
                jdaviescoates @Enabl.ist 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? ๐Ÿ™‚

                I use Cloudron with Gandi & Hetzner

                1 Reply Last reply Reply Quote 0
                • fbartels
                  fbartels App Dev @jdaviescoates last edited by

                  @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 0
                  

                  You do not need the lamp app, surfer can directly host the files for you.

                  V 1 Reply Last reply Reply Quote 0
                  • V
                    vjvanjungg @fbartels last edited by vjvanjungg

                    @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!

                    robi fbartels 2 Replies Last reply Reply Quote 0
                    • robi
                      robi @vjvanjungg 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.

                      Life of Advanced Technology

                      V 1 Reply Last reply Reply Quote 1
                      • V
                        vjvanjungg @robi last edited by

                        thanks @robi! will test it there.

                        1 Reply Last reply Reply Quote 0
                        • fbartels
                          fbartels App Dev @vjvanjungg last edited by

                          @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.

                          V 1 Reply Last reply Reply Quote 1
                          • V
                            vjvanjungg @fbartels last edited by

                            @fbartels thanks for sharing the process, iโ€™ll have to play around with it some more. appreciate the thoughts/insights.

                            1 Reply Last reply Reply Quote 0
                            • ?
                              A Former User 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

                              V 1 Reply Last reply Reply Quote 3
                              • V
                                vjvanjungg @Guest last edited by

                                @atrilahiji 99833BF2-14EC-44DD-960C-9704ADA0F154.jpeg 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 ๐Ÿ˜„

                                ? 1 Reply Last reply Reply Quote 1
                                • ?
                                  A Former User @vjvanjungg 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?

                                  V 1 Reply Last reply Reply Quote 0
                                  • V
                                    vjvanjungg @Guest 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?

                                    ? 2 Replies Last reply Reply Quote 0
                                    • ?
                                      A Former User @vjvanjungg 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.

                                      1 Reply Last reply Reply Quote 0
                                      • ?
                                        A Former User @vjvanjungg 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.

                                        V 2 Replies Last reply Reply Quote 1
                                        • V
                                          vjvanjungg @Guest last edited by

                                          @atrilahiji gotcha, awesome awesome ๐Ÿ˜‰๐Ÿ‘iโ€™ll try it , (think) i can do it now

                                          1 Reply Last reply Reply Quote 0
                                          • V
                                            vjvanjungg @Guest last edited by

                                            @atrilahiji thank you!๐Ÿ˜‡

                                            1 Reply Last reply Reply Quote 0
                                            • N
                                              ntnsndr last edited by

                                              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!

                                              girish 1 Reply Last reply Reply Quote 1
                                              • girish
                                                girish Staff @ntnsndr last edited by

                                                @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.

                                                N 1 Reply Last reply Reply Quote 1
                                                • N
                                                  ntnsndr @girish last edited by

                                                  @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:4a63ad48a6fbbd168828769b0d796b511d09d173ab5dd64368338997164aa4ab

                                                  Here's the repo: https://gitlab.com/medlabboulder/docs

                                                  Let me know if there's anything else I should do. But for now it deploys!

                                                  girish 1 Reply Last reply Reply Quote 2
                                                  • girish
                                                    girish Staff @ntnsndr last edited by

                                                    @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.

                                                    1 Reply Last reply Reply Quote 0
                                                    • First post
                                                      Last post
                                                    Powered by NodeBB