Install Git and an AsciiDoc Editor
The Couchbase documentation is stored on GitHub, so if you don’t have a GitHub account, you need to create one.
To clone and work with Git repositories on your device, i.e., local repositories, install Git using your operating system’s package manager. Alternatively, you can download it from the Git project.
AsciiDoc is the markup language Couchbase uses for writing documentation. You can write an AsciiDoc document using a plain text editor or integrated development environment (IDE). If you don’t have a preferred text editor or IDE, install Atom and the listed AsciiDoc packages for an enhanced experience.
Atom is an open source, extensible text editor that works on Linux, macOS, and Windows.
Start Atom and go to Ctrl+,. This opens the Settings panel.or press
In the sidebar on the left, click Install.
In the input field labeled Search packages, enter each package listed below, and install them.
language-asciidocpackage provides AsciiDoc syntax highlighting and snippets.
asciidoc-previewpackage renders a preview an AsciiDoc document in Atom.