Skip to content

Commit

Permalink
Update emojis b/c some are deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
hugoledoux committed Aug 21, 2024
1 parent 0183c4f commit b1caa6c
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/python/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Installing and using Python as recommended below has major benefits and will prevent problems in the future.

!!! warning ":simple-windows: Windows: use the python.org version!"
!!! warning ":material-microsoft-windows: Windows: use the python.org version!"

pyenv was created for macOS and Linux, and although it has a Windows version (called "**pyenv-win**"), this is not working very well and the installation is buggy.

Expand Down
28 changes: 14 additions & 14 deletions docs/styleguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

This page is intended as a reference for **styling conventions** used on the site to achieve consistency. The Markdown source can be used as snippets.

!!! tip ":simple-visualstudiocode: Visual Studio Code snippets"
!!! tip ":material-microsoft-visual-studio-code: Visual Studio Code snippets"
The repository contains snippet shortcut files for Visual Studio Code. On this page, if you see something starting with a backslash `\` it is the shortcut for placing that snippet.
Make sure in Visual Studio code the following options are enabled:
```json
Expand Down Expand Up @@ -45,13 +45,13 @@ Inline: ++ctrl+alt+del++ (++cmd+option+del++ on macOS) `++ctrl+alt+del++ (++cmd+

Tabs:
```markdown
=== ":simple-windows: :simple-linux: Windows & Linux"
=== ":material-microsoft-windows: :simple-linux: Windows & Linux"
++ctrl+alt+del++
=== ":simple-apple: macOS"
++cmd+option+del++
```

=== ":simple-windows: :simple-linux: Windows & Linux"
=== ":material-microsoft-windows: :simple-linux: Windows & Linux"
++ctrl+alt+del++
=== ":simple-apple: macOS"
++cmd+option+del++
Expand Down Expand Up @@ -133,7 +133,7 @@ data = np.array([2,3,4])


###### OS
- :simple-windows: Windows: `:simple-windows:` `\iwindows`
- :material-microsoft-windows: Windows: `:material-microsoft-windows:` `\iwindows`
- :simple-linux: Linux: `:simple-linux:` `\ilinux`
- :simple-apple: macOS: `:simple-apple:` `\imacos`, `\iapple`
- :material-web: www application: `:material-web:`
Expand All @@ -144,7 +144,7 @@ data = np.array([2,3,4])
###### Software
- :simple-pycharm: Pycharm `:simple-pycharm:` `\ipycharm`
- :simple-clion: CLion `:simple-clion:` `\iclion`
- :simple-visualstudiocode: Visual Studio Code `:simple-visualstudiocode:` `\ivscode`
- :material-microsoft-visual-studio-code: Visual Studio Code `:material-microsoft-visual-studio-code:` `\ivscode`
- :simple-qgis: QGIS `:simple-qgis:` `\iqgis`
- :simple-arcgis: ArcGIS `:simple-arcgis:` `\iarcgis`

Expand All @@ -158,16 +158,16 @@ These should be split into content tabs with consistent tab naming.

Since the website uses global tabs, only use the predefined names:

- :simple-windows: Windows `:simple-windows: Windows`
- :material-microsoft-windows: Windows `:material-microsoft-windows: Windows`
- :simple-apple: macOS `:simple-apple: macOS`
- :simple-linux: Linux `:simple-linux: Linux`
- :simple-apple: :simple-linux: Unix (macOS & Linux) `:simple-apple: :simple-linux: Unix (macOS & Linux)`
- :simple-windows: :simple-linux: Windows & Linux `:simple-windows: :simple-linux: Windows & Linux` (Mainly used for shortcuts)
- :material-microsoft-windows: :simple-linux: Windows & Linux `:material-microsoft-windows: :simple-linux: Windows & Linux` (Mainly used for shortcuts)

Windows/macOS/Linux. `\os_win_macos_linux`.

```md
=== ":simple-windows: Windows"
=== ":material-microsoft-windows: Windows"

Windows instructions here

Expand All @@ -180,7 +180,7 @@ These should be split into content tabs with consistent tab naming.
Linux instructions here
```

=== ":simple-windows: Windows"
=== ":material-microsoft-windows: Windows"

Windows instructions here

Expand All @@ -195,7 +195,7 @@ These should be split into content tabs with consistent tab naming.
Windows/Unix. `\ow_win_unix`.

```md
=== ":simple-windows: Windows"
=== ":material-microsoft-windows: Windows"

Windows instructions here

Expand All @@ -204,7 +204,7 @@ These should be split into content tabs with consistent tab naming.
Linux instructions here
```

=== ":simple-windows: Windows"
=== ":material-microsoft-windows: Windows"

Windows instructions here

Expand All @@ -215,7 +215,7 @@ These should be split into content tabs with consistent tab naming.
Windows&Linux/macOS `\os_winlinux_macos`

```md
=== ":simple-windows: :simple-linux: Windows & Linux"
=== ":material-microsoft-windows: :simple-linux: Windows & Linux"
Windows & Linux instructions here
Expand All @@ -225,15 +225,15 @@ These should be split into content tabs with consistent tab naming.
```

=== ":simple-windows: :simple-linux: Windows & Linux"
=== ":material-microsoft-windows: :simple-linux: Windows & Linux"
Windows & Linux instructions here
=== ":simple-apple: macOS"
macOS instructions here

=== ":simple-windows: Windows"
=== ":material-microsoft-windows: Windows"

Windows instructions here

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ markdown_extensions:
permalink: true # Add permalink symbol to end of headers
- def_list # Ordered and unordered lists
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
Expand Down

0 comments on commit b1caa6c

Please sign in to comment.