Skip to content

Latest commit

 

History

History
218 lines (161 loc) · 5.58 KB

READ_ENGLISH.md

File metadata and controls

218 lines (161 loc) · 5.58 KB
Raw

CodeView

(my engilsh is not good ,if you have any question,you can ask me by e-mail : thereisnospon@qq.com)

CodeView is a android widget can show code and hightlight it . The code is rendering by hightlight.js , it not only can automatically recognize the dominant languages such as java,c++,c#,python,bash,ruby and more.. but also have many kinds of themes you can choose.

example:

</td>

it can not only show code snippet，but also have replaced all the specified code in the HTML file with highlighted to come out, and the other part keep unchanged.

etc：

get(gradle)

compile 'thereisnospon.codeview:codeview:0.3.1'

use

in the layout:

 <thereisnospon.codeview.CodeView
        android:id="@+id/codeview"
        android:layout_width="match_parent"
        android:layout_height="match_parent">
</thereisnospon.codeview.CodeView>

in java code：

 public class MainActivity extends AppCompatActivity {
    CodeView codeView;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        codeView=(CodeView)findViewById(R.id.codeview);
        codeView.setTheme(CodeViewTheme.ANDROIDSTUDIO).fillColor();
        //CODE is your code which  you want to show,type is String
        codeView.showCode(CODE);
    }
}

then is ok,it can recognize your code language automatically。

if you want hightlight many code snippet in a html:

<!DOCTYPE html>
<html>
<head>
	<title></title>
</head>
<body>
<h1>This is a code</h1>
<pre class="code">
#include<stdio.h>
int main()
{
	printf("hello world");
}
</pre>
<h1>This is another code</h1>
<pre class="code">
class Main
{
	private String name;
	Main(String name){
		this.name=name;
	}
	public static void main(String []args){
		Main main=new Main("hello");
		System.out.println("init");
	}
}
</pre>
</body>
</html>

this code snippet both have a same class "code"

you can hightlight them by two ways:

 codeView.showCodeHtmlByClass(Constant.HTML,"code");

you can also using css selector ,such as:

 codeView.showCodeHtmlByCssSelect(Constant.HTML,".code");

change theme

default theme is DEFAULT 。CodeViewTheme is a enum type

 codeView.setTheme(CodeViewTheme.DRACULA)

you can using this method to list all themes

 public static CodeViewTheme[]listThemes()；

som other methods:

	//set encoding ,utf-8 is default
	public CodeView setEncode(String encode);
	//fill background color
	public CodeView fillColor()；
	//show code ,recognize language automatically。
	public void showCode(String code)；
	//show code and  specifying language,but it is undone.
	public void showCode(Code code)

you can clone this project to local,app have som useage demo,you can browse all theme and concreate useage

if you think is interesting ,can give a star

ofcourse ,it is my first open source library,it must have many trouble,and bug,you can give me some addvice, and then,i can learn more.

mail ：thereisnospon@qq.com

Release Demo

there is a release version: https://github.com/Thereisnospon/CodeView/releases

version update 1 ：

0.2.1 change min sdk to 14

0.3.0 update

add two methods ,fix show image in html (because many image url is relative address)

   public void setBaseUrl(String baseUrl
   public void setHistoryUrl(String historyUrl)

using highlight.js to hightlight

Copyright (c) 2006, Ivan Sagalaev All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.
* Neither the name of highlight.js nor the names of its contributors 
  may be used to endorse or promote products derived from this software 
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

and using Jsoup to parse thml