Unixorn aspires to be a Unix-like environment with a shell interface that:
-
can be embedded into a website
-
comes with a set of built-in commands and keybindings
-
can be extended with additional commands, keybindings and styles
You can view a live example of Unixorn in action.
Execute yarn add unixorn.
import React, { Component } from 'react'
import Unixorn from 'unixorn'
const configuration = {}
class Example extends Component {
render() {
return <Unixorn {...configuration} />
}
}
import { initUnixorn } from 'unixorn'
const configuration = {}
const nonReactDomNode = document.getElementById('example')
initUnixorn(nonReactDomNode, configuration)
Consult the docs generated with typedoc.
The following classes may be targeted for styling:
- unixorn-base
- unixorn-current
- unixorn-cursor
- unixorn-error
- unixorn-input
- unixorn-output
- unixorn-prompt
- unixorn-startup-message
If you wish to submit a pull request, you should probably check the contributing guide first.
Execute yarn install.
Execute yarn run build.
Execute yarn start.
Execute yarn docs.
Execute yarn install and yarn start in the example folder.
Execute yarn test.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent