Skip to content
forked from fastlane/docs

Introducing the all new fastlane docs, now even easier to read

Notifications You must be signed in to change notification settings

larryonoff/docs

 
 

Repository files navigation

fastlane docs

This repo contains all documentation for fastlane. You can find the .md files inside the docs folder.

To preview the updated documentation locally, just clone the repo, modify the file, and run

mkdocs serve

The live version is available on docs.fastlane.tools.

Why new docs?

You can find more information here

Deploy changes

Once a PR is merged into master, the latest version will automatically be deployed to docs.fastlane.tools by one of the hard working fastlane bots. No need to do anything manually. The resulting HTML files are stored in the gh-pages branch.

Installation of mkdocs

brew install python # if you don't have pip already
[sudo] pip install -r requirements.txt

Adding a Python dependency

Likely, to add a Markdown extension.

  1. Install with pip install <some extension>
  2. Add to requirements-to-freeze.txt.
  3. Run pip freeze > requirements.txt to update the exact requirements.

Why requirements-to-freeze.txt?

Based on A Better Pip Workflow, requirements-to-freeze.txt and requirements.txt provide a similar experience to Gemfile and Gemfile.lock, respectively.

requirements-to-freeze.txt lets you pick out the top level packages the project depends on, while requirements.txt exactly specifies all of the dependencies and subdependencies for repeatable builds.

About

Introducing the all new fastlane docs, now even easier to read

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 80.5%
  • HTML 12.2%
  • Shell 7.3%