Skip to content

Commit bc851c5

Browse files
authored
Merge pull request mkdocs#1052 from waylan/install
Added some system specific installation instructions.
2 parents 6306ce4 + 384428b commit bc851c5

File tree

1 file changed

+46
-14
lines changed

1 file changed

+46
-14
lines changed

docs/index.md

Lines changed: 46 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,28 @@ the theme.
3737

3838
## Installation
3939

40-
In order to install MkDocs you'll need [Python] installed on your system, as
41-
well as the Python package manager, [pip]. You can check if you have these
42-
already installed from the command line:
40+
### Install with a Package Manager
41+
42+
If you have and use a package manager (such as [apt-get], [dnf], [homebrew],
43+
[yum], etc.) to install packages on your system, then you may want to search for
44+
a "MkDocs" package and, if a recent version is available, install it with your
45+
package manager (check your system's documentation for details). That's it,
46+
you're done! Skip down to [Getting Started](#getting-started).
47+
48+
If your package manager does not have a recent "MkDocs" package, you can still
49+
use your package manager to install "Python" and "pip". Then you can use pip to
50+
[install MkDocs](#installing-mkdocs).
51+
52+
[apt-get]: https://help.ubuntu.com/community/AptGet/Howto
53+
[homebrew]: http://brew.sh/
54+
[dnf]: http://dnf.readthedocs.io/en/latest/index.html
55+
[yum]: http://yum.baseurl.org/
56+
57+
### Manual Installation
58+
59+
In order to manually install MkDocs you'll need [Python] installed on your
60+
system, as well as the Python package manager, [pip]. You can check if you have
61+
these already installed from the command line:
4362

4463
```bash
4564
$ python --version
@@ -50,15 +69,24 @@ pip 1.5.2
5069

5170
MkDocs supports Python versions 2.6, 2.7, 3.3, 3.4, 3.5 and pypy.
5271

53-
### Installing Python
72+
#### Installing Python
5473

5574
Install [Python] by downloading an installer appropriate for your system from
56-
<https://www.python.org/downloads/> and running it.
75+
[python.org] and running it.
5776

58-
### Installing pip
77+
!!! Note
78+
79+
If you are installing Python on Windows, be sure to check the box to have
80+
Python added to your PATH if the installer offers such an option (it's
81+
normally off by default).
82+
83+
[python.org]: https://www.python.org/downloads/
5984

60-
If you're using a recent version of Python, pip is most likely installed
61-
by default. However, you may need to upgrade pip to the lasted version:
85+
#### Installing pip
86+
87+
If you're using a recent version of Python, the Python package manager, [pip],
88+
is most likely installed by default. However, you may need to upgrade pip to the
89+
lasted version:
6290

6391
```bash
6492
pip install --upgrade pip
@@ -71,7 +99,7 @@ Then run the following command to install it:
7199
python get-pip.py
72100
```
73101

74-
### Installing MkDocs
102+
#### Installing MkDocs
75103

76104
Install the `mkdocs` package using pip:
77105

@@ -98,14 +126,18 @@ mkdocs, version 0.15.3
98126
python -m mkdocs
99127

100128
For a more permanent solution, you may need to edit your `PATH` environment
101-
variable to include the `Scripts` directory of your Python installation. The
102-
specifics of how to do that depend on how your system is configured and
103-
which method you used to install Python and is beyond the scope of this
104-
document.
129+
variable to include the `Scripts` directory of your Python installation.
130+
Recent versions of Python include a script to do this for you. Navigate to
131+
your Python installation directory (for example `C:\Python34\`), open the
132+
`Tools`, then `Scripts` folder, and run the `win_add2path.py` file by double
133+
clicking on it. Alternatively, you can [download][a2p] the script and run it
134+
(`python win_add2path.py`).
135+
136+
[a2p]: https://svn.python.org/projects/python/trunk/Tools/scripts/win_add2path.py
105137

106138
---
107139

108-
## Getting started
140+
## Getting Started
109141

110142
Getting started is super easy.
111143

0 commit comments

Comments
 (0)