Skip to content
a Gradle based AsciiDoc Toolchain for Software Architecture Documentation
Groovy VBScript Shell PowerShell Batchfile Dockerfile
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update FUNDING.yml Dec 23, 2019
bin Lint shell scripts with shellcheck and fix findings Oct 15, 2019
docs updated docs May 13, 2020
gradle/wrapper Update gradle wrapper to 6.0.1 to support Java 13 Jan 14, 2020
images cdc tweet Mar 10, 2020
resources Replace asciidoctor-reveal.js with submodule Oct 14, 2017
scripts extended the logic a bit May 26, 2020
src Fix the initialisation of ancestorId to take value also from Config.g… May 26, 2020
template_config merge with upstream/master Nov 3, 2019
.ci.sh Add integration tests and doc creation based on the commands as docum… Oct 15, 2019
.editorconfig add details to .editorconfig Oct 14, 2019
.gitignore Add extendable CI script which runs via CI and locally Oct 15, 2019
.gitmodules Replace asciidoctor-reveal.js with submodule Oct 14, 2017
.gitpod.dockerfile added gitpod config Jun 24, 2019
.gitpod.yml added gitpod config Jun 24, 2019
.travis.yml Update gradle wrapper to 6.0.1 to support Java 13 Jan 14, 2020
CODE_OF_CONDUCT.md selected template Jan 11, 2019
CONTRIBUTORS.adoc Add myself to contributors and link it to the repo root for visibility Oct 14, 2019
Config.groovy updated config comments to include reference to fallback Feb 25, 2020
LICENSE Update LICENSE Jan 11, 2019
README.adoc added sponsor info May 8, 2020
SECURITY.adoc Create SECURITY.adoc Sep 7, 2019
build.gradle Revert "Revert "Update of asciidoctorj-pdf to latest release version … Apr 15, 2020
changelog.adoc #282 possible fix collect includes (#302) Jun 11, 2019
copyDocs.sh Lint shell scripts with shellcheck and fix findings Oct 15, 2019
gradle.properties Revert "Revert "Update of asciidoctorj-pdf to latest release version … Apr 15, 2020
gradlew add memory settings for the Gradle deamon (required for task generate… Apr 13, 2020
gradlew.bat add memory settings for the Gradle deamon (required for task generate… Apr 13, 2020
init.gradle update com.github.ben-manes.versions to 0.27.0 Oct 25, 2019
settings.gradle simple asciidoc build with gradle Jul 5, 2016

README.adoc

docToolchain

Note

Corona/Covid19 is taking its toll. Time is short in these times and issues are not worked on. That’s why I (rdmueller) have just introduced sponsored issues with higher priority. The label should help to explain why some issues will be preferred over others. If you want to sponsor an issue, just use the sponsor link on top of this page.

Important

if you’ve used docToolchain in the past, please be aware that the master branch is undergoing some changes.

If you are looking for a fresh version and are willing to accept changes in the configuration, the master branch is the right thing for you.

If you are looking for what you are used to, then download the V1.0.0 release

Build Status Backers on Open Collective Sponsors on Open Collective

create awesome docs!

docToolchain is an implementation of the docs-as-code approach for software architecture. The basis of docToolchain is the philosophy that software documentation should be treated in the same way as code together with the arc42 template for software architecture.

Overview2

Contributors

This project exists thanks to all the people who contribute!

contributors

See also the list of contributors from the docs.

Each contribution is highly valuable and appreciated, no matter how big it is - there are no small contributions. Even just fixing a typo or starring the project helps to promote it.

I decided to give people and companies a chance to support this project. This is done through https://opencollective.com - the same service which Asciidoctor uses.

Companies who use docToolchain

docToolchain is still one of the smaller open source projects, but some companies already fully embrace the docs-as-code approach through docToolchain. If your company uses docToolchain, then feel free to add your companies logo through a pull request. Please state in the PR that we are allowed to display the logo within all projects websites and documentation.

TomTom

Deutsche Bahn - DB Systel

Backers

Thank you to all our backers!

Become a Backer

Sponsors

Support us by becoming a sponsor. Your logo will show up here with a link to your website.

Sponsor

History of this project

I just found an older tweet which remindet me of the roots and beginning of this project. It all began with two important parts. A script called asciidoc2confluence and some scripts to export diagrams from enterprise architect.

The first one is linked in the tweet above and the first commit dates back to mid of 2015. Since then, many contributors have joined! Thanx for all of your contributions!

You can’t perform that action at this time.