We all have families who tell us "take a look at the laptop that is slow for me", we usually have to deal with the generation of documents. If we need to generate an installation guide, documents available to use in our project, or any other need and we want:
- Make it as automatable as possible. It is cumbersome to have a word, which somewhere is needed in PDF, in another HTML, ... All of them kept on our repository (Git, SVN or whatever is appropriate).
- Don't let the editor distract us by applying text auto-formats all the time. Microsoft Word and the like (LibreOffice?) Is NOT what we need.
AsciiDoctor will function as an abstraction interface on all of this. Format complexity and coupling to document editing software.
Follow along this notes. You will need to have at least Java 8 installed or some openJDK distribution, and Gradle on the PATH.
You can use some package management tool for windows. E.g. Chocolatey
- OpenJDK8 Zulu - Java Development Kits (OpenJDK build)
choco install zulu8 -y
- Gradle - Constructor and manager dependencies
choco install gradle --version 5.6.4 -y
Clone this repository, and fire up a command-line tool.
To know the document as code technique , It necessary check diff between use editor and markdown code to generate documents
To execute the Gradle example:
gradle build
gradle asciidoctor
Can you support me?I will continue to do things and expose notes, but existing many ways to support what I do:
- Pull requests are welcome a 💫
- Don't forget to give this Repository a 🌟
- Buy me a ☕