DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:codeprism

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:codeprism [2023-12-03 09:58] – [Table] siyuanliuplugin:codeprism [2023-12-08 07:18] (current) – [codeprism Plugin] siyuanliu
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: +description: Provide nice syntax highlighting using Prism.js
 author     : siyuanliu  author     : siyuanliu 
 email      : siyuanl96@gmail.com  email      : siyuanl96@gmail.com 
 type       : syntax, action type       : syntax, action
 lastupdate : 2023-12-03 lastupdate : 2023-12-03
-compatible : "Jack Jackrum"+compatible : Jack Jackrum
 depends    :  depends    : 
 conflicts  conflicts 
-similar    : dokuprism +similar    : dokuprism, codify 
-tags       : code, prismhighlight+tags       : code, prismjssyntaxhighlight
  
 downloadurl: https://github.com/siyuanl96/dokuwiki-plugin-codeprism/archive/refs/tags/v1.0.tar.gz downloadurl: https://github.com/siyuanl96/dokuwiki-plugin-codeprism/archive/refs/tags/v1.0.tar.gz
Line 25: Line 25:
 Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually. Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
-===== Examples/Usage =====+===== Examples / Usage =====
  
-{{https://raw.githubusercontent.com/siyuanl96/dokuwiki-issue/main/codeprism/codeprism-demo.png}}+=== Syntax highlight ===
  
-You can also watch more demos at [[https://wiki.pushmindstack.com/tools/dokuwiki/codeprism|here]].+{{https://raw.githubusercontent.com/siyuanl96/dokuwiki-issue/main/codeprism/codeprism-demo.png?400x200&recache}} 
 + 
 +=== Command line === 
 + 
 +{{https://raw.githubusercontent.com/siyuanl96/dokuwiki-issue/main/codeprism/codeprism-cmdline.png?400x200&recache}} 
 + 
 +=== CSS preview === 
 + 
 +{{https://raw.githubusercontent.com/siyuanl96/dokuwiki-issue/main/codeprism/codeprism-previewer.png?400x200&recache}} 
 + 
 +You can also watch demos at [[https://wiki.pushmindstack.com/tools/dokuwiki/codeprism|here]].
  
 ===== Syntax ===== ===== Syntax =====
Line 47: Line 57:
 | ''hl''                                                 | Highlight line numbers                             | One number or multiple numbers with '','' or ''-'' (''-'' indicates range).                                                                                                                                                                    | ''hl=1,3,4-9''           | | ''hl''                                                 | Highlight line numbers                             | One number or multiple numbers with '','' or ''-'' (''-'' indicates range).                                                                                                                                                                    | ''hl=1,3,4-9''           |
 | ''lang''                                               | Language                                           | See [[https://prismjs.com/index.html#supported-languages|this page]].                                                                                                                                                                          | ''lang=php''             | | ''lang''                                               | Language                                           | See [[https://prismjs.com/index.html#supported-languages|this page]].                                                                                                                                                                          | ''lang=php''             |
-| ''cmd''                                                | Command line style                                 | ''true''. (If '''' is set, ''cmd'' is set to ''true'' by default.)                                                                                                                                                                             | ''cmd=true''             |+| ''cmd''                                                | Command line style                                 | ''true''. (If ''cmdout'' is set, ''cmd'' is set to ''true'' by default.)                                                                                                                                                                       | ''cmd=true''             |
 | ''cmdout''                                             | Command output line numbers                        | One number or multiple numbers with '','' or ''-'' (''-'' indicates range).                                                                                                                                                                    | ''cmdout=2,4,6-9''       | | ''cmdout''                                             | Command output line numbers                        | One number or multiple numbers with '','' or ''-'' (''-'' indicates range).                                                                                                                                                                    | ''cmdout=2,4,6-9''       |
-| ''css''                                                | Assign a custom CSS to the code block              | Default is ''dft''. You can create a CSS named ''pre.dokuwiki-plugin-codeprism-**custom**'' ((''custom'' is any word you like to use)) in [[https://www.dokuwiki.org/devel:css#user_styles|conf/userstyle.css]] and use it by ''css=custom'' | ''css=custom''           |+| ''css''                                                | Assign a custom CSS to the code block              | Default is ''dft''. You can create a CSS named ''pre.dokuwiki-plugin-codeprism-**custom**'' ((''custom'' is any word you like to use)) in [[devel:css#user_styles|conf/userstyle.css]] and use it by ''css=custom'' | ''css=custom''           |
 | ''user''                                               | Specify the user name at the command shell prompt  | A string without spaces. (If the ''user'' is not specified, the default user name configured in the **Configuration Settings** is used. You can also use ''user'' to re-specify a new user name.)                                              | ''user=Source''          | | ''user''                                               | Specify the user name at the command shell prompt  | A string without spaces. (If the ''user'' is not specified, the default user name configured in the **Configuration Settings** is used. You can also use ''user'' to re-specify a new user name.)                                              | ''user=Source''          |
 | ''host''                                               | Specify the host name at the command shell prompt  | A string without spaces. (If the ''host'' is not specified, the default host name configured in the **Configuration Settings**  is used. You can also use ''host'' to re-specify a new host name.)                                             | ''host=Debian''          | | ''host''                                               | Specify the host name at the command shell prompt  | A string without spaces. (If the ''host'' is not specified, the default host name configured in the **Configuration Settings**  is used. You can also use ''host'' to re-specify a new host name.)                                             | ''host=Debian''          |
Line 65: Line 75:
 ===== Configuration and Settings ===== ===== Configuration and Settings =====
  
-^ Setting        ^ Description                                                                                         +^ Setting        ^ Description                                                                                                                         
-Theme          | Specify Codeprism theme.                                                                            +theme          | Specify Codeprism theme.                                                                                                            
-| cdn            | Specify a CDN which provide PrismJS.                                                                +| cdn            | Specify a CDN which provide PrismJS.                                                                                                
-| custom-cdn     | Specify the CDN yourself if the CDNs listed in the <wrap menu>cdn</wrap> does not meet your needs.  +| custom-cdn     | Specify the CDN yourself if the CDNs listed in the setting ''cdn'' does not meet your needs.                                        
-| override-code  | **True** to override ''code'' syntax.                                                               +| override-code  | **True** to override ''code'' syntax.                                                                                               
-| show-invis     | **True** to show hidden characters such as tabs and line breaks.                                    +| show-invis     | **True** to show hidden characters such as tabs and line breaks.                                                                    
-| hl-brace       | **True** to highlight brace pairs when the cursor hovers over one of the braces.                    +| hl-brace       | **True** to highlight brace pairs when the cursor hovers over one of the braces.                                                    
-| previewer      | **True** to enable preview angle, color, gradient, easing, and time.                                +| previewer      | **True** to enable preview angle, color, gradient, easing, and time.                                                                
-| user           | Specify the default user name at the command shell prompt when using [[#cmd|command line style]]  +| user           | Specify the default user name at the command shell prompt when using command line style((Using ''cmd'' or ''cmdout'' attribute.)).  
-| host           | Specify the default host name at the command shell prompt when using [[#cmd|command line style]]  |+| host           | Specify the default host name at the command shell prompt when using command line style((Using ''cmd'' or ''cmdout'' attribute.)).  |
  
 ===== Development ===== ===== Development =====
plugin/codeprism.1701593917.txt.gz · Last modified: 2023-12-03 09:58 by siyuanliu

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki