You can have a look at hugo, with some simple theme like hugo-book
this post was submitted on 06 Sep 2024
26 points (100.0% liked)
Ask Lemmy
26995 readers
1393 users here now
A Fediverse community for open-ended, thought provoking questions
Please don't post about US Politics. If you need to do this, try [email protected]
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
founded 1 year ago
MODERATORS
The example site is a bit cluttered, but maybe that's just optional, will check out, thanks!
VitePress might be what you're looking for.
Tried it but how do you actually build the static html files? It's only explaining how to run the site through some sort of java script machinery?
Nice otherwise, thanks!
I like mkdocs because it generates the entire site from markdown files
Thanks, I just tested mdBook and it does just that, it's great!
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.
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).
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:
I usually create an "images" sub-folder next to the Markdown file, then it's just:
Very nice, will definitely check out!
Seems like exactly what I'm looking for.
Update, works wonders thank you so much! ๐
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.
Thanks, but for now I think that looks like overkill for my small needs.
It's really simple to use, and markdown is essentially plain text.
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.