33## Install
44```
55pip install -r requirements.txt
6- npm install
6+ npm install
77npm install -g sass
88```
99
@@ -12,25 +12,24 @@ npm install -g sass
1212Build static site
1313` mkdocs build `
1414
15- Start local server
15+ Start local server
1616` mkdocs serve `
1717
1818> [ !TIP]
1919> If you encounter cairo linking issue, you can try the [ workaround solution] ( https://github.com/Kozea/cairocffi/issues/28#issuecomment-1173455046 ) .
2020
2121
22- ## Landing page
23- If you are updating the CSS styles for the ` landing page ` , it is generated from the root ` sass ` :
24- ` sass --watch sass/home.sass docs/styles/home.css `
25-
26- ## Other customizations
22+ ## Styling
23+ If you are updating the CSS styles, it is generated from the ` extra.css ` file:
2724
2825[ Extra css] ( https://www.mkdocs.org/user-guide/customizing-your-theme/ ) for documentation pages can be added here:
2926
3027```
3128/docs/styles/extra.css
3229```
3330
31+ ## Other customizations
32+
3433Overrides, such as the custom landing page, are stored in the following location:
3534
3635```
@@ -39,9 +38,9 @@ Overrides, such as the custom landing page, are stored in the following location
3938```
4039
4140## Configuration options
42- Configuration options are set in the ` mkdocs.yml ` file.
41+ Configuration options are set in the ` mkdocs.yml ` file.
4342- [ MKDocs Configuration] ( https://www.mkdocs.org/user-guide/configuration/ )
44- -
43+ -
4544
4645## Adding new feature pages
47461 . To add new features, create a Markdown file in ` docs/docs/features ` and added a title, e.g.:
@@ -78,7 +77,7 @@ Please use [pngquant](https://pngquant.org/) to optimize any PNG files:
7877pngquant --force --quality=100 --strip --skip-if-larger --verbose <filename>.png
7978```
8079
81- Try to keep animated gifs no bigger than around 1MB. Only use multiple large gifs on one page if absolutely neccessary.
80+ Try to keep animated gifs no bigger than around 1MB. Only use multiple large gifs on one page if absolutely neccessary.
8281
8382
8483
0 commit comments