this post was submitted on 06 Sep 2024
26 points (100.0% liked)

Ask Lemmy

26250 readers
1517 users here now

A Fediverse community for open-ended, thought provoking questions


Rules: (interactive)


1) Be nice and; have funDoxxing, 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 spamPlease do not flood the community with nonsense. Actual suspected spammers will be banned on site. No astroturfing.


4) NSFW is okay, within reasonJust 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:

Tech Support

No Stupid Questions

You Should Know

Reddit

Jokes

Ask Ouija


Logo design credit goes to: tubbadu


founded 1 year ago
MODERATORS
 

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
[โ€“] [email protected] 2 points 1 week ago (3 children)

My go-to for this is pandoc, it takes markdown and can generate html, pdf, word, OpenOffice and other formats.

Because it uses markdown, you can use version control and grep on your documentation and include it with your source code.

[โ€“] [email protected] 1 points 1 week ago (2 children)

Thanks, but for now I think that looks like overkill for my small needs.

[โ€“] [email protected] 1 points 1 week ago (1 children)

It's really simple to use, and markdown is essentially plain text.

[โ€“] [email protected] 1 points 1 week ago

I haven't tried yet, but it seens like a lot to just get up and running, will check out if that other one doesn't make static websites.