Skip to content
This repository has been archived by the owner on May 31, 2023. It is now read-only.

Commit

Permalink
Fixup README wording
Browse files Browse the repository at this point in the history
  • Loading branch information
janbrasna authored Jul 3, 2022
1 parent 73c666a commit bc4e77b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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

```
mkdocs serve
Expand All @@ -16,7 +16,7 @@ You can find more information [here](https://github.com/fastlane/docs/issues/5)

## Deploy changes

Once a 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. No need to do anything manually. The resulting HTML files are stored in the [`gh-pages`](https://github.com/fastlane/docs/tree/gh-pages) branch.
Once a 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. No need to do anything manually. 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/)

Expand All @@ -35,6 +35,6 @@ Likely, to add a [Markdown extension](https://pythonhosted.org/Markdown/extensio

## Troubleshooting local docs server

Running local server with `mkdocs serve` takes several minutes. It looks like `mkdocs` needs several minutes to read `available-plugins.md`. It can be confirmed by running `mkdocs serve --verbose` as `mkdocs` is stuck at reading this file.
Running a local server with `mkdocs serve` takes several minutes. It looks like `mkdocs` needs some time to read `available-plugins.md`. It can be confirmed by running `mkdocs serve --verbose` as `mkdocs` is stuck at reading this file.

To test changes on other pages than list of available plugins, its convenient to edit `docs/generated/available-plugins.md` and remove all its content and save file before running `mkdocs serve`.
To test changes on pages other than the list of available plugins, it is convenient to edit `docs/generated/available-plugins.md`, removing all of its content and saving the file before running `mkdocs serve`.

0 comments on commit bc4e77b

Please sign in to comment.