From a6c319761420245e88a37b39f20bf97b80b079e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A1ra=20El-Saig?= Date: Mon, 22 Apr 2024 01:42:30 +0200 Subject: [PATCH] Copy README.md from simplify-docs branch. see https://github.com/sarahelsaig/OrchardCore/commits/78279dac4c3202ab0c5f9924a7214c4b37fd9caa/src/docs/topics/docs-contributions/README.md --- src/docs/topics/docs-contributions/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/docs/topics/docs-contributions/README.md b/src/docs/topics/docs-contributions/README.md index d75839d845a..55d577c0037 100644 --- a/src/docs/topics/docs-contributions/README.md +++ b/src/docs/topics/docs-contributions/README.md @@ -26,7 +26,7 @@ Do the following if you're adding docs for a newly developed extension, or if yo With MkDocs you can get the full docs.orchardcore.net experience locally too. If you are looking to contribute substantial amount of docs then please do run the site locally to make sure what you write will actually look like it should. -1. Follow the [MkDocs installation guide](https://www.mkdocs.org/#installation) to install Python. once you have Python installed you won't need to install MkDocs by hand, we'll do that in a next step. If you're on Windows be sure to add the Python `Scripts` folder to the `PATH` as noted there, otherwise none of the `mkdocs` commands will be found. You may need to add your user's Scripts folder (something like `C:\Users\\AppData\Roaming\Python\Python39\Scripts`) to the `PATH` too. +1. Follow the [MkDocs installation guide](https://www.mkdocs.org/user-guide/installation/) to install Python, PIP and MkDocs. If you already have a fresh enough Python installation, you can simply run `pip install mkdocs`. 2. Open a command line in the root of your clone of the repository. -3. Run `pip3 install -r src/docs/requirements.txt` to install dependencies. -4. Run `mkdocs serve` to start the site. You'll then be able to browse it under . +3. Run `pip install -r src/docs/requirements.txt` to install dependencies. +4. Run `python -m mkdocs serve` to start the site. You'll then be able to browse it under .