An open API service indexing awesome lists of open source software.

https://github.com/fastlane/docs

All the fastlane docs
https://github.com/fastlane/docs

fastlane hack hacktoberfest hacktoberfest2021

Last synced: 5 months ago
JSON representation

All the fastlane docs

Awesome Lists containing this project

README

          

# fastlane docs

This repository contains all documentation for fastlane. You can access the `.md` files inside the [docs](docs) folder.

To preview the updated documentation locally, just clone the repo, modify the file, and run the command. Note that some of the files are in [generated](docs/generated) folder and are later copied with `mkdocs` pre-build hook.

```
mkdocs serve
```

The live version is available on [docs.fastlane.tools](https://docs.fastlane.tools).

## Why new docs?

You can find more information [here](https://github.com/fastlane/docs/issues/5)

## Deploy changes

Once a pull request (PR) is merged into master, the latest version will automatically be deployed to [docs.fastlane.tools](https://docs.fastlane.tools) by one of the hard-working fastlane bots. There is no need to perform any manual actions. The resulting HTML files are stored in the [`gh-pages`](https://github.com/fastlane/docs/tree/gh-pages) branch.

## Installation of [mkdocs](http://www.mkdocs.org/)

```sh
brew install python3 # if you don't have pip already
brew install pipenv
pipenv --three
# install dependencies from Pipfile.lock and run shell
pipenv install
pipenv shell
```

## Adding a Python dependency

Likely, to add a [Markdown extension](https://pythonhosted.org/Markdown/extensions/), install it with `pipenv install ` after making sure the virtualenv is loaded (`pipenv shell`).