readme.md

Documentation Cafe

A personal technical writing project!
Explore the site »

Table of Contents

1. Built with
2. Prerequisites
3. Installation
4. Usage
5. License

Built with

About the project

Documentation Cafe is a personal project with the following goals:

* House my technical writing portfolio
* Practice technical writing
* Document my interests

Prerequisites

The things you need before installing the software.

• NPM
• Node
• AsciiDoctor
• Antora

Build

A step by step guide that will tell you how to get the development environment up and running. Build is located in the documentation-cafe/docCafeSite/build/site folder

$ git clone https://github.com/IvyCap/documentation-cafe-builder.git
$ cd documentation-cafe-builder/
$ npx antora --fetch doccafe-playbook.yml

License

Documentation Cafe © 2024 by KRM is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International

(back to top)