Formatting text instructions into html?
-
I want to create readme, installation and configuration instructions using a text editor that can be read as text. But also having the option of converting the text file into nice looking static html files.
What format should I use and what tools are available to convert text files into static html?
I'm thinking maybe something like markdown? I've only really used different types of markup in a wiki context, not as standalone files.
-
Joplin
-
I love markdown for this.
How are these files being presented?
That really determines how you need to design it.
-
@JaredBusch said in Formatting text instructions into html?:
I love markdown for this.
How are these files being presented?
That really determines how you need to design it.
Text files are *.md but I want to convert them to html and put them on a webserver as well. I was hoping there is some utility that can turn *.md into *.html, perhaps with a CSS file for styling.
-
@Pete-S said in Formatting text instructions into html?:
@JaredBusch said in Formatting text instructions into html?:
I love markdown for this.
How are these files being presented?
That really determines how you need to design it.
Text files are *.md but I want to convert them to html and put them on a webserver as well. I was hoping there is some utility that can turn *.md into *.html, perhaps with a CSS file for styling.
Actually I'm kind of stupid. I see now standalone editors for markdown actually have export to html and pdf and what not as options already. So I can use that to generate html files.
-
@Pete-S said in Formatting text instructions into html?:
@Pete-S said in Formatting text instructions into html?:
@JaredBusch said in Formatting text instructions into html?:
I love markdown for this.
How are these files being presented?
That really determines how you need to design it.
Text files are *.md but I want to convert them to html and put them on a webserver as well. I was hoping there is some utility that can turn *.md into *.html, perhaps with a CSS file for styling.
Actually I'm kind of stupid. I see now standalone editors for markdown actually have export to html and pdf and what not as options already. So I can use that to generate html files.
Yeah, that's how MD is normally used, if not in a wiki. Otherwise, the wiki itself is the markdown to html converter.
-
I prefer asciidoc to markdown. Asciidoc has actual standards for things. Antora will build a pretty nice site with your projects written in Asciidoc as well.
Ifyou just want a single page, Asciidoctor will build a site as well.
-
@flaxking said in Formatting text instructions into html?:
Joplin
Thanks for sharing that. It's not what I'm looking for right now but I can see using it in other situations.
-
@stacksofplates said in Formatting text instructions into html?:
I prefer asciidoc to markdown. Asciidoc has actual standards for things. Antora will build a pretty nice site with your projects written in Asciidoc as well.
Ifyou just want a single page, Asciidoctor will build a site as well.
I had a look at asciidoc and it looks very nice, especially for larger documentation projects.
-
@Pete-S said in Formatting text instructions into html?:
@stacksofplates said in Formatting text instructions into html?:
I prefer asciidoc to markdown. Asciidoc has actual standards for things. Antora will build a pretty nice site with your projects written in Asciidoc as well.
Ifyou just want a single page, Asciidoctor will build a site as well.
I had a look at asciidoc and it looks very nice, especially for larger documentation projects.
I have a couple projects in an Antora site. We had a ton more at work, but I can't show it on here. You can include multiple projects and have them appear at the bottom left, each with versions. We used it so that teams could create documentation for tools (or really whatever they wanted) and then that documentation could be scraped and included in the central site. I just have a few projects included in my site, but Antora makes that pretty easy.
Here's my very bad/basic example.
