File tree Expand file tree Collapse file tree 1 file changed +25
-4
lines changed Expand file tree Collapse file tree 1 file changed +25
-4
lines changed Original file line number Diff line number Diff line change @@ -31,6 +31,23 @@ significantly diverged from the upstream `mkdocs-material
3131Getting Started
3232---------------
3333
34+ Installation
35+ ~~~~~~~~~~~~
36+
37+ From the PyPI
38+ ^^^^^^^^^^^^^
39+
40+ .. code-block :: bash
41+
42+ pip install sphinx-immaterial
43+
44+ From git source
45+ ^^^^^^^^^^^^^^^
46+
47+ .. code-block :: bash
48+
49+ pip install git+https://github.com/jbms/sphinx-immaterial.git
50+
3451 .. admonition :: Prerequisites
3552
3653 Building the theme from source requires node.js v14 or newer installed.
@@ -41,11 +58,9 @@ Getting Started
4158 Installing from a distributed wheel (such as from pypi.org) does not require
4259 node.js installed.
4360
44- Install from git source
4561
46- .. code-block :: bash
47-
48- pip install git+https://github.com/jbms/sphinx-immaterial.git
62+ Sphinx configuration
63+ ~~~~~~~~~~~~~~~~~~~~
4964
5065Update your ``conf.py `` with the required changes:
5166
@@ -66,6 +81,12 @@ or ``theme.conf`` for more details.
6681 :start-after: # -- HTML theme specific settings
6782 :end-before: # end html_theme_options
6883
84+ .. important ::
85+ :title: Migrating from another theme
86+ :collapsible:
87+
88+ Be advised to clean prior builds before the first build with a new theme.
89+
6990
7091.. toctree ::
7192 :hidden:
You can’t perform that action at this time.
0 commit comments