OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Removed references to Clipboard from docs

Browse Source
This commit is contained in:
squidfunk 2017-05-31 16:53:05 +02:00
parent bca2077c1e
commit 9a24b60cdf
1 changed files with 16 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/getting-started.md
View File

@ -412,31 +412,16 @@ extra:
tabs: true tabs: true
``` ```
### Clipboard.js Integration
Material supports [Clipboard.js][20] and will provide overlays on code blocks
for easy copying. When mousing over a code block you will see a button in
the upper right hand corner of the code. You can click the icon and have the
entire content of the that code block copied to the clipboard without needing
Flash. Clipboard.js support can be enabled by with the following settings:
```yaml
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.6.1/clipboard.min.js
```
[20]: https://clipboardjs.com/
### More advanced customization ### More advanced customization
If you want to change the general appearance of the Material theme, see If you want to change the general appearance of the Material theme, see
[this article][21] for more information on advanced customization. [this article][20] for more information on advanced customization.
[21]: customization.md [20]: customization.md
## Extensions ## Extensions
MkDocs supports several [Markdown extensions][22]. The following extensions MkDocs supports several [Markdown extensions][21]. The following extensions
are not enabled by default (see the link for which are enabled by default) are not enabled by default (see the link for which are enabled by default)
but highly recommended, so they should be switched on at all times: but highly recommended, so they should be switched on at all times:
@ -450,20 +435,20 @@ markdown_extensions:
For more information, see the following list of extensions supported by the For more information, see the following list of extensions supported by the
Material theme including more information regarding installation and usage: Material theme including more information regarding installation and usage:
* [Admonition][23] * [Admonition][22]
* [Codehilite][24] * [Codehilite][23]
* [Footnotes][25] * [Footnotes][24]
* [Metadata][26] * [Metadata][25]
* [Permalinks][27] * [Permalinks][26]
* [PyMdown Extensions][28] * [PyMdown Extensions][27]
[22]: http://www.mkdocs.org/user-guide/writing-your-docs/#markdown-extensions [21]: http://www.mkdocs.org/user-guide/writing-your-docs/#markdown-extensions
[23]: extensions/admonition.md [22]: extensions/admonition.md
[24]: extensions/codehilite.md [23]: extensions/codehilite.md
[25]: extensions/footnotes.md [24]: extensions/footnotes.md
[26]: extensions/metadata.md [25]: extensions/metadata.md
[27]: extensions/permalinks.md [26]: extensions/permalinks.md
[28]: extensions/pymdown.md [27]: extensions/pymdown.md
## Full example ## Full example
@ -513,8 +498,4 @@ markdown_extensions:
- admonition - admonition
- codehilite(guess_lang=false) - codehilite(guess_lang=false)
- toc(permalink=true) - toc(permalink=true)
# CSS
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.6.0/clipboard.min.js
``` ```