Technical Writing With Asciidoc And Intellij Idea

Learn how to install IntelliJ and use it effectively for technical writing in AsciiDoc

What you'll learn

Installing IntelliJ together with the plugin for AsciiDoc

Navigating in existing documentation projects

Writing AsciiDoc content in IntelliJ

Optimize the preview in the IDE for AsciiDoc

Creating a pull request for a Git repository

Requirements

No previous knowledge about IntelliJ is necessary.

Previous experience in technical writing and AsciiDoc is a plus, but not required.

Basic understanding of Git is required for the chapter covering Git in IntelliJ

Description

New to IntelliJ IDEA and wonder how to get started with AsciiDoc and Documentation as Code? This beginner’s course takes from and installing IntelliJ IDEA to using it effectively to write, review and navigate technical documentation written in AsciiDoc.The AsciiDoc plugin for IntelliJ IDEA provides you with the best tools to write and validate your content in your IDE. All course material is presented by Alexander Schwartz, the maintainer of the AsciiDoc plugin for IntelliJ and an active member of the AsciiDoc community.It covers all steps necessary to get you ready for Technical Writing with AsciiDoc and IntelliJ IDEA:Installing IntelliJ IDEA as the workplace for technical writing.Starting IntelliJ IDEA for the first time and installing the AsciiDoc plugin.Opening the first project in IntelliJ IDEA.Adding a file to a project and editing AsciiDoc content in an existing project.Making use of the preview to validate the content.Learning the AsciiDoc Syntax via small exercises.Using IntelliJ to submit changes to Git via a pull request.Navigating from one file to other referenced files in a project.Searching AsciiDoc content in a large project.After this course, you’ll be able to contribute to a documentation project that uses AsciiDoc for its technical documentation via IntelliJ IDEA.During the course, you can contact the instructor with your questions.

Overview

Section 1: Choosing IntelliJ IDEA for technical writing

Lecture 1 Technical Writing in IntelliJ IDEA

Section 2: Getting ready with IntelliJ IDEA

Lecture 2 Installing IntelliJ IDEA

Lecture 3 Starting and customizing IntelliJ IDEA

Lecture 4 Opening a project

Section 3: Writing AsciiDoc content

Lecture 5 Editing AsciiDoc content

Lecture 6 Improving the preview

Lecture 7 Learning the AsciiDoc Syntax

Lecture 8 Working with Git and GitHub

Section 4: Searching and navigating content

Lecture 9 Navigating from file to file

Lecture 10 Searching within files of a project

Section 5: Congratulations & Closing

Lecture 11 Good bye and stay in touch!

Technical writers who want to get familiar with writing AsciiDoc content in IntelliJ