KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #developer-tools #cli #codex #claude-code #dsh-plugin #mcp #react #agent #dsh #deepseek-harness

vuepress-theme-terminal

★ 100 Open GitHub ↗

A terminal theme for VuePress!

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# vuepress-theme-terminal
<img src="https://i.ibb.co/gJc6psR/image.png" alt="image" border="0">

> A terminal (portfolio) theme for VuePress based on [vue-terminal](https://github.com/jsmith/vue-terminal)!

## Demos
[Basic Demo](https://jsmith.github.io/vuepress-theme-terminal)

## Installation
```
npm install vuepress-theme-terminal
```

## Usage
This theme is best used for a portfolio site.

See the `demo/` folder for a working example!

Here is a brief overview:
```javascript
// yourprojectfolder/.vuepress/config.js
module.exports = {
  ...
  theme: 'terminal',
  ...
}
```

```yaml
# yourprojectfolder/README.md

---
user: john
welcome: Welcome to John's Portfolio!
about: Current Software Engineering Student @ BUC. My name is John!
socials:
    - title: github
      link: github.com/john
    - title: linkedin
      link: linkedin.com/in/john
    - title: email
      link: john@john.ca
projects:
    -   title: vue-terminal
        link: github.com/jsmith/prompt
        description: >
            `vue-terminal` is the Vue component library I made to power this website. It tries
            its best to mimic a regular zsh shell (tab completion, simple commands, etc.).
    -   title: another-project
        description: An awesome project basically!
        link: github.com/john/another-project
---
```

Want to see something a bit more complex? See my [portfolio configuration](https://raw.githubusercontent.com/jsmith/portfolio/5ce6445fb6036cfdfa4efd1c0ffeb3adab4b869e/jsmith.github.io/README.md).

> Beware of using project names with spaces as this is not currently supported.

## Missing a feature?
This project was developed for my personal portfolio. As such, I only implemented the features I needed. If there is a new feature you'd like to see implemented, create a issue or put up a PR (contributions are very welcome).

## Development
Want to work on this library? Install the dependencies:
```
npm i
```

Symlink this folder to node_modules so that vuepress can find the files :)
```
ln -s $(pwd) $(pwd)/node_modules/vuepress-theme-terminal
```

then run the development server!
```
npm run dev  # run hot reload
```

### Publishing
```
VERSION=YOUR_VERSION
git add .
git commit -m "$VERSION"
git tag v$VERSION
git push
npm publish
```

vuepress-theme-terminal

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README