thegooddocsproject / templates

Templates created by The Good Docs Project - for all your tech writing needs.
https://thegooddocsproject.dev/
Other
680 stars 170 forks source link

Write The Docs (WTD Portland) 2020: Transform templates to your wiki format #151

Open ScriptAutomate opened 4 years ago

ScriptAutomate commented 4 years ago

Hello, there!

What's this about?

This issue was opened up as a way to track discussion, feedback, brainstorming, use cases, etc. around how a tool such as pandoc can be used to transform templates to ideal file formats. It will be periodically updated throughout writing day.

I ultimately want to come out of writing day with a basic how-to on getting pandoc running, converting templates to other formats, and issue. This will mean we will have basic directions for people to follow at the terminal, and a list of issues that TGD can pull from to develop better support and out-of-box experience.

The long-term goal would be to contribute upstream to pandoc itself so that it can support what people ultimately want.

Why a GitHub issue?

An issue seemed the most transparent approach to this discussion, and opens it up as something easily searchable in the future to anyone who lands at this repository.

Issue Updates

This issue will update throughout the WTD writing day.

Pandoc

Pandoc is meant to be a universal documentation converter tool. For information:

Hugo

Hugo uses archetypes, and is their approach to templating within Hugo projects. It would be great to have some kind of baseline conversion to these.

acpkendo commented 4 years ago

I've done some simple Bash scripting that runs Pandoc on an entire directory into multiple formats, the concept of which could be useful if we include a "build docset" or similar concept as part if a larger toolchain.