Skip to content

shubanker/bash-folio

Repository files navigation

Bash Folio

A Shell like Ux to showcase folio with typewritter effect.

Shell Folio

Configuration

You can easily configure your username & your list of commands/outputs in commands.config.ts

configure the command and its output:

[
    { command: "whoami", typeWritterText: `Hello world` }
]

Custom Component

You can also render a custom component as output :

[
    { command: "skp-md-viewer card.md", component: SocialCard }
]

For custom components you need to call "next()" passed in props inside your custom component to tell console to continue with next commands.

export const HelloWorld: React.FC<{ next: () => void }> = ({ next }) => {
  useEffect(() => {
    setTimeout(() => {
      next();//continues with next commands.
    }, 1000);
  }, [next]);
  return <div> Hello World</div>;
};

License

This project is licensed under the MIT License - see the LICENSE file for details.