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


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 🙂

  • App Dev

    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.

  • Staff

    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? 🙂

  • App Dev

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