Hello all!

I’m documenting a small FOSS project, and I’m looking for some soft that translates a documentation into a web page.

Something simple, with a side board that links the pages/titles/sub-titles, and is PC and Mobile compatible. Basically images, italics, bold and links, with titles and subtitles, would be nice 🙂.

Like the Lemmy install guide for example: https://join-lemmy.org/docs/administration/install_docker.html

Any recommendations?

Thank you all!

  • Ephera@lemmy.ml
    2·
    3 months ago

    That Lemmy guide uses mdBook: https://rust-lang.github.io/mdBook/

    It originates from the Rust ecosystem, but it’s basically language agnostic.
    You basically provide it Markdown files in a certain file structure and then it does the rest. Really easy to use.

    • Valmond@lemmy.worldOP
      1·
      3 months ago

      Very nice! Seems like a hassle to install though, but I’ll definitely check it out, looks exactly what I’m looking for (as long as you can throw in images, didn’t see that at my first very brief glance).

      • Ephera@lemmy.ml
        2·
        3 months ago

        Hmm, I think, you can download one of the .tar.gz files from here: https://github.com/rust-lang/mdBook/releases
        Unpack it and then just run the executable that’s inside.

        And yes, images are absolutely possible.
        You can just place the image file in the file structure and then in your Markdown file, you can use this syntax:

        ![Optional description for sight-impaired users](relative/path/to/image.png)

        I usually create an “images” sub-folder next to the Markdown file, then it’s just:

        ![](images/something.png)