# portainer-docs

**Repository Path**: xunyev2/portainer-docs

## Basic Information

- **Project Name**: portainer-docs
- **Description**: https://github.com/portainer/portainer-docs.git
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-08
- **Last Updated**: 2022-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="left">
  <img src="https://avatars1.githubusercontent.com/u/22225832?s=400&v=4" width="200">
</p>

# Portainer Admin Guides and Documentation
This repository contains the Portainer v1.x, v2.x and futures versions documentation.

## Contributing
We welcome and encourage community contributions.
For information about contributing to the Portainer documentation, see [Contribution guidelines](contributing.md).

The [issues](https://github.com/portainer/portainer-docs/issues) of this repo is the place to manage our To Do. We encourage you to see what has to be done, take a task and contribute.

## Running the docs locally

1. [**Clone this repository**](https://help.github.com/articles/cloning-a-repository/) to your local machine.

2. **Install Mkdocs**

   The Portainer Documentation uses [MkDocs](https://www.mkdocs.org/). MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Install MkDocs using the following [installation guide](https://www.mkdocs.org/#installation)

3. **Install Material Theme**

   <code>pip install mkdocs-material</code>

4. **Start MkDocs Server**

   Multiple sites are hosted in this repository, if you are contributing for v2.0, navigate to the folder `v2.0` and start MkDocs Server running:

   <code>mkdocs serve</code>