Skip to content

Commit

Permalink
imporved doc
Browse files Browse the repository at this point in the history
  • Loading branch information
vickeykumar committed Jun 16, 2024
1 parent ee5fc32 commit 062acfc
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ jsconsole/build/static/js/jsconsole.js: jsconsole/node_modules/webpack $(JS_FILE
bindata/static/js/jsconsole.js: jsconsole/build/static/js/jsconsole.js
cp jsconsole/build/static/js/jsconsole.js bindata/static/js/jsconsole.js

CHAT_JS_FILES := $(wildcard resources/chat-widget/src/widget.*) $(wildcard resources/chat-widget/*.json) $(wildcard resources/chat-widget/*.js) resources/chat-widget/src/index.ts
CHAT_JS_FILES := $(wildcard resources/chat-widget/src/widget.*) $(wildcard resources/chat-widget/*.json) $(wildcard resources/chat-widget/*.js) resources/chat-widget/src/index.ts resources/chat-widget/src/openreplkeywords.ts

resources/chat-widget/dist/index.umd.js: $(CHAT_JS_FILES)
@echo "building chat-widget: "
Expand Down
1 change: 1 addition & 0 deletions src/containers/container.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ var Commands2memLimitMap = map[string]int64{
"jq-repl": 2,
"tclsh": 2,
"java": 128, // jvm takes lot of memory
"evcxr": 50, // rust REPL
}

var memLimitMutex sync.Mutex
Expand Down
82 changes: 80 additions & 2 deletions src/resources/chat-widget/src/openreplkeywords.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,80 @@
export const keywords = `OpenREPL, Login Getting started Blogs Documentation , OpenREPL beta, An Open Source Platform to run and test code snippets instantaneously with OpenREPL, , Read–Eval–Print-Loop, , Email Facebook LinkedIn Pinterest Twitter, , , C, , debug , Welcome to OpenREPL, }, \t\t, , , Env Vars/Paths (space delim), , Compiler/Repl Args, , 14, , Terminal, , C and C++, , cling, +, Getting Started, , [cling]$ #inclu, , , , , Commands, .help, .L libname, .rawInput, .q, Note:, Descriptions, Display brief descriptions of all meta-commands., Load the given file or library., Toggle on/off raw input., Exits Cling Interpreter., runtime extraction of value is not supported in c-mode., Please read documentation for more information, , Documentation, , , , Get In Touch, Which language REPL you want to see next?, Please Leave your comments in case of any Suggestions/Feedback. Thanks :), , Name, Email, Message, , , Fast To Learn, Start writing your code snippets immediately in any REPL! No more time wasted on opening and navigating your text editor, writing code, compile and run to see the results., , Secure and Containerized REPLs, REPLs are created and destroyed on the fly using containers. REPLs can be forked to create a child terminal in the same container that can communicate with the parent REPL. Useful in case of socket/http programming., , Meta-Commands, Each REPL terminal has some meta-commands to perform administrative tasks., , Prototyping and Proofs of Concepts, Helps you learn a programming language faster., , Share/Collaborate, Share your REPL Instance with Others to collaborate with others. Click 'Share REPL' button to generate a unique REPL ID which can be shared with Others., peerchat, peerchat button on openrepl, About, References, OpenREPL`
export const documentation = `\nOpenREPL is an Online platform for checking codes in REPLs for various languages like C/C++, golang, python etc. It can be very useful for exploratory programming and debugging, specially for those who are beginners in learning any of the new programming languages. It can also be very useful for the developers who want to check small code snippets quickly in REPL before embedding the code in there applications. Learn how to play around REPL.\n\nFollow below links for specific languages to know more:\n\nCling for C/C++\nThe C++ interactive interpreter Cling is based on LLVM and its C++ frontend clang. For more information on cling, check the documentation below :\n\nCling for C/C++ Documentation\nGolang\nPlease find the link below for documentation on our dummy gointerpreter:\n\nGolang Documentation\nJava\nJava interpreter Jshell is released with standard Java 9. I found some helpful links and resources regarding all java REPLs for you as below:\n\nJava Documentation\nPython\nPlease refer to links below to know about python interpreter:\n\nPython Documentation\nRead Our Blogs to know more about OpenREPL.`
export const keywords = `OpenREPL, Login Getting started Blogs Documentation, OpenREPL beta, An Open Source Platform to run and test code snippets instantaneously with OpenREPL, Read–Eval–Print-Loop, Email Facebook LinkedIn Pinterest Twitter, debug, Welcome to OpenREPL, Env Vars/Paths (space delim), Compiler/Repl Args, Terminal, C and C++, cling, Getting Started, .help, .L libname, .rawInput, .q, Note:, Descriptions, Display brief descriptions of all meta-commands., Load the given file or library., Toggle on/off raw input., Exits Cling Interpreter., runtime extraction of value is not supported in c-mode., Please read documentation for more information, Documentation, Get In Touch, Which language REPL you want to see next?, Please Leave your comments in case of any Suggestions/Feedback. Thanks :), Name, Email, Message, Fast To Learn, Start writing your code snippets immediately in any REPL! No more time wasted on opening and navigating your text editor, writing code, compile and run to see the results., Secure and Containerized REPLs, REPLs are created and destroyed on the fly using containers. REPLs can be forked to create a child terminal in the same container that can communicate with the parent REPL. Useful in case of socket/http programming., Meta-Commands, Each REPL terminal has some meta-commands to perform administrative tasks., Prototyping and Proofs of Concepts, Helps you learn a programming language faster., Share/Collaborate, Share your REPL Instance with Others to collaborate with others. Click 'Share REPL' button to generate a unique REPL ID which can be shared with Others., peerchat, peerchat button on openrepl, About, References, OpenREPL`
export const documentation = `\nOpenREPL is an Online platform for checking codes in REPLs for various languages like C/C++, golang, python etc. It can be very useful for exploratory programming and debugging, specially for those who are beginners in learning any of the new programming languages.` +
`{
"Resources": [
{
"language": "C and C++",
"title": "Cling Documentation",
"documentation": "./docs/cling.html",
"github": "https://github.com/root-project/cling"
},
{
"language": "Go",
"title": "Yaegi Documentation",
"documentation": "https://pkg.go.dev/github.com/traefik/yaegi",
"github": "https://github.com/traefik/yaegi"
},
{
"language": "Go",
"title": "Go Interpreter Documentation",
"documentation": "./docs/gointerpreter.html",
"github": "https://github.com/vickeykumar/Go-interpreter"
},
{
"language": "jq",
"title": "jq Manual",
"documentation": "https://stedolan.github.io/jq/manual",
"github": "https://github.com/vickeykumar/jq-repl"
},
{
"language": "Python",
"title": "Python Documentation",
"documentation": "./docs/python.html",
},
{
"language": "Java",
"title": "Java Documentation",
"documentation": "./docs/java.html",
"github": "https://github.com/javaterminal/tryjshell"
},
{
"language": "bash",
"title": "Linux Commands",
"documentation": "http://linuxcommand.org/index.php",
},
{
"language": "Ruby",
"title": "Ruby Quickstart",
"documentation": "https://www.ruby-lang.org/en/documentation/quickstart/",
},
{
"language": "JavaScript",
"title": "JavaScript Documentation",
"documentation": "https://developer.mozilla.org/bm/docs/Web/JavaScript",
"github": "https://github.com/vickeykumar/jsconsole"
},
{
"language": "Node.js",
"title": "Node.js REPL Documentation",
"documentation": "https://nodejs.org/dist/latest-v10.x/docs/api/repl.html",
"github": "https://github.com/nodejs/node"
},
{
"language": "Perl",
"title": "Perl Tutorials",
"documentation": "https://www.guru99.com/perl-tutorials.html",
"github": "https://github.com/mklement0/perli"
},
{
"language": "Tcl",
"title": "Tcl Tutorial",
"documentation": "https://www.tcl.tk/man/tcl8.5/tutorial/tcltutorial.html",
},
{
"language": "Rust",
"title": "Rust Book",
"documentation": "https://doc.rust-lang.org/book/title-page.html",
"github": "https://github.com/evcxr/evcxr"
}
]
}`

0 comments on commit 062acfc

Please sign in to comment.