Skip to content

Alna Documentation

The goal of this project is demonstrating how to create a technical documentation, easily to maintain and grow it up fast, for developers, DevOps, engineer and software architects.

Markdown - Site: mkdocs.org

Markdown - Docs: markdownguide.org/basic-syntax

Markdown - Editor: stackedit.io

MkDocs - Guides mkdocs.org

MkDocs - Material: squidfunk.github.io.

MkDocs - Material Guides: squidfunk.github.io/reference

Docs with Markdown

To create all documentation we are going to use a notation called Markdown. Markdown is a popular and easy way to write documents, without a need to install anything or having a big training to use it. In a few words a would say it is a simple technic, not a huge technology 🙂

You can learn more about Markdown in: Markdown Topic

Docs using MkDocs

To help us to publish the Markdown as a website\wiki documentation, now we are going to use a tool called MkDocs. It is a free and open source tool that allow us to manage and publish our Markdown documentation.

You can learn more about MkDocs in: MkDocs Topic

Get Start

Now that we have the technic and the tool (Markdown + MkDocs) we are ready to start a project to create and publish out first documentation. However, there are a few requirements that you have to attend before starting:

  1. Install Git
  2. Clone docs Git repositorie: Alna Docs
  3. Go to the Get Start guide: Get Start Topic