Ask Lemmy@lemmy.world · 2 months ago

FOSS tool for documentation on the web

Valmond@lemmy.world to

Ask Lemmy@lemmy.world · 2 months ago

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!

Chat

grandel@lemmy.ml
link
fedilink
arrow-up
2·
2 months ago
I like mkdocs because it generates the entire site from markdown files
- Valmond@lemmy.worldOP
  link
  fedilink
  arrow-up
  1·
  edit-2
  2 months ago
  Thanks, I just tested mdBook and it does just that, it’s great!

Ask Lemmy@lemmy.world

asklemmy@lemmy.world

Create a post

You are not logged in. However you can subscribe from another Fediverse account, for example Lemmy or Mastodon. To do this, paste the following into the search field of your instance: [email protected]

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 [email protected] or [email protected]. 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 [email protected]. For other questions check our partnered communities list, or use the search function.

Reminder: The terms of service apply here too.

Partnered Communities:

Logo design credit goes to: tubbadu

Visibility: Public

This community can be federated to other instances and be posted/commented in by their users.

1.75K users / day
5.65K users / week
9.32K users / month
21.4K users / 6 months
2 local subscribers
26.7K subscribers
3.97K Posts
209K Comments
Modlog