Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README file #155

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,32 @@
# Fleek Documentation

Join our public [Slack](https://slack.fleek.co/), visit our [GitHub](https://github.com/FleekHQ), follow us on [Twitter](https://twitter.com/FleekHQ), and check out the [Blog](https://blog.fleek.co)!
Welcome to the Fleek Documentation repository! Here, you'll find all the information you need to get started with Fleek and make the most of our platform.

## Getting started
To stay up-to-date with the latest news and developments, we invite you to join our public Slack, visit our GitHub, follow us on Twitter, and check out our Blog!

## Getting Started

### Prerequisites
- python >= 3.7.4
- pip >= 20.1.1
- Python >= 3.7.4
- Pip >= 20.1.1

### Commands
Before executing any mkdocs command, make sure to install the `mkdocs-material` package by running:

Before executing any mkdocs command, make sure to install [mkdocs-material](https://github.com/squidfunk/mkdocs-material) by running:

```sh
``` PowerShell
pip install mkdocs-material
```

#### Run Locally
```sh
#### Running Locally
To run the documentation locally, simply run the following command:

``` PowerShell
mkdocs serve
```

#### Build
```sh
#### Building
To build the documentation, run:

``` PowerShell
mkdocs build
```
```