FOSS tool for documentation on the web (lemmy.world)

submitted 2 months ago by Valmond@lemmy.world to c/asklemmy@lemmy.world

15 comments fedilink hide all child comments

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!

you are viewing a single comment's thread
view the rest of the comments

[-] Valmond@lemmy.world 1 points 2 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 points 2 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)

[-] Valmond@lemmy.world 2 points 2 months ago

Very nice, will definitely check out!

Seems like exactly what I'm looking for.

[-] Valmond@lemmy.world 2 points 2 months ago

Update, works wonders thank you so much! 💖

this post was submitted on 06 Sep 2024

26 points (100.0% liked)

Ask Lemmy

26672 readers

938 users here now

A Fediverse community for open-ended, thought provoking questions

Please don't post about US Politics.

Rules: (interactive)

1) Be nice and; have fun

Doxxing, trolling, sealioning, racism, and toxicity are not welcomed in AskLemmy. Remember what your mother said: if you can't say something nice, don't say anything at all. In addition, the site-wide Lemmy.world terms of service also apply here. Please familiarize yourself with them

2) All posts must end with a '?'

This is sort of like Jeopardy. Please phrase all post titles in the form of a proper question ending with ?

3) No spam

Please do not flood the community with nonsense. Actual suspected spammers will be banned on site. No astroturfing.

4) NSFW is okay, within reason

Just remember to tag posts with either a content warning or a [NSFW] tag. Overtly sexual posts are not allowed, please direct them to either !asklemmyafterdark@lemmy.world or !asklemmynsfw@lemmynsfw.com. NSFW comments should be restricted to posts tagged [NSFW].

5) This is not a support community.

It is not a place for 'how do I?', type questions. If you have any questions regarding the site itself or would like to report a community, please direct them to Lemmy.world Support or email info@lemmy.world. For other questions check our partnered communities list, or use the search function.

Reminder: The terms of service apply here too.