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


  • Categories
  • Recent
  • Tags
  • Popular
  • Bookmarks
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse

Cloudron Forum

Apps | Demo | Docs | Install

MKdocs project documentation

Scheduled Pinned Locked Moved Solved App Wishlist
24 Posts 9 Posters 1.2k Views
    • 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.istE Offline
    Enabl.istE Offline
    Enabl.ist
    wrote on last edited by
    #1

    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
    2
  • fbartelsF Offline
    fbartelsF Offline
    fbartels App Dev
    wrote on last edited by
    #2

    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
    0
  • nebulonN Offline
    nebulonN Offline
    nebulon Staff
    wrote on last edited by
    #3

    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.

    jdaviescoatesJ 1 Reply Last reply
    1
  • Enabl.istE Offline
    Enabl.istE Offline
    Enabl.ist
    wrote on last edited by
    #4

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

    Thanks!

    jdaviescoatesJ 1 Reply Last reply
    0
  • jdaviescoatesJ Offline
    jdaviescoatesJ Offline
    jdaviescoates
    replied to nebulon on last edited by
    #5

    @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

    fbartelsF 1 Reply Last reply
    0
  • jdaviescoatesJ Offline
    jdaviescoatesJ Offline
    jdaviescoates
    replied to Enabl.ist on last edited by
    #6

    @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
    0
  • fbartelsF Offline
    fbartelsF Offline
    fbartels App Dev
    replied to jdaviescoates on last edited by
    #7

    @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
    0
  • V Offline
    V Offline
    vjvanjungg
    replied to fbartels on last edited by vjvanjungg
    #8

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

    robiR fbartelsF 2 Replies Last reply
    0
  • robiR Offline
    robiR Offline
    robi
    replied to vjvanjungg on last edited by
    #9

    @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 sky tech

    V 1 Reply Last reply
    1
  • V Offline
    V Offline
    vjvanjungg
    replied to robi on last edited by
    #10

    thanks @robi! will test it there.

    1 Reply Last reply
    0
  • fbartelsF Offline
    fbartelsF Offline
    fbartels App Dev
    replied to vjvanjungg on last edited by
    #11

    @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
    1
  • V Offline
    V Offline
    vjvanjungg
    replied to fbartels on last edited by
    #12

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

    1 Reply Last reply
    0
  • ? Offline
    ? Offline
    A Former User
    wrote on last edited by
    #13

    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
    3
  • V Offline
    V Offline
    vjvanjungg
    replied to A Former User on last edited by
    #14

    @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
    1
  • ? Offline
    ? Offline
    A Former User
    replied to vjvanjungg on last edited by
    #15

    @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
    0
  • V Offline
    V Offline
    vjvanjungg
    replied to A Former User on last edited by
    #16

    @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
    0
  • ? Offline
    ? Offline
    A Former User
    replied to vjvanjungg on last edited by
    #17

    @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
    0
  • ? Offline
    ? Offline
    A Former User
    replied to vjvanjungg on last edited by
    #18

    @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
    1
  • V Offline
    V Offline
    vjvanjungg
    replied to A Former User on last edited by
    #19

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

    1 Reply Last reply
    0
  • V Offline
    V Offline
    vjvanjungg
    replied to A Former User on last edited by
    #20

    @atrilahiji thank you!๐Ÿ˜‡

    1 Reply Last reply
    0

  • Login

  • Don't have an account? Register

  • Login or register to search.
  • First post
    Last post
0
  • Categories
  • Recent
  • Tags
  • Popular
  • Bookmarks
  • Login

  • Don't have an account? Register

  • Login or register to search.