Skip to content

Commit

Permalink
merge: merge pull request #34 from henryhale/docs/showcase
Browse files Browse the repository at this point in the history
docs: add showcase section
  • Loading branch information
henryhale committed Dec 29, 2023
2 parents 3dac7ef + b6f5922 commit 941f205
Show file tree
Hide file tree
Showing 7 changed files with 1,830 additions and 1,484 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ The complete documentation for `XTerminal` can be found [here](https://xterminal

The full Public API for `XTerminal` can also be found within this [TypeScript declaration file](https://github.com/henryhale/xterminal/blob/master/source/types.ts).

## Showcase

Several projects that are using XTerminal are listed [here](https://xterminal.js.org/showcase). Feel free to open a pull request adding your project in this [file](https://github.com/henryhale/xterminal/blob/master/docs/showcase/index.md).

## Browser Support

Supporting wide range of browsers is the goal. Modern browsers, most specifically the latest versions of Chrome, Firefox, Safari, and Edge (for desktop and mobile devices) are supported.
Expand Down
3 changes: 2 additions & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export default defineConfig({
{ text: 'Home', link: '/' },
{ text: 'Guide', link: '/guide/' },
{ text: 'Demo', link: '/demo/' },
{ text: 'Showcase', link: '/showcase/' },
{
text: 'About',
items: [
Expand All @@ -50,7 +51,7 @@ export default defineConfig({
},
{
text: 'Essentials',
collapsed: true,
collapsed: false,
items: [
{ text: 'Initialization', link: '/guide/initialization' },
{ text: 'Output', link: '/guide/output' },
Expand Down
55 changes: 55 additions & 0 deletions docs/.vitepress/theme/components/ProjectCards.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<script setup>
const props = defineProps(['projects']);
</script>

<template>
<div class='grid'>
<div v-for='(p, i) in projects' :key='i' class="row">
<div class="grow">
<div class="row">
<img :src='p.logo' :alt='p.name' width="45" />
<span>
{{ p.name }}<br>{{ p.desc }}<br>
<a :href='p?.author.link'>@{{ p?.author.username }}</a>
</span>
</div>
</div>
<div>
<a :href='p.link'>Visit &RightArrow;</a>
</div>
</div>
</div>
</template>
<style scoped>
.grid {
display: flex;
flex-direction: column;
padding: 4rem 1rem;
}
.grid>* {
margin-bottom: 2rem;
width: 100%;
max-width: 720px;
margin: 0 auto;
}
.row {
display: flex;
align-items: center;
padding: 1rem 0;
}
.row>*:not(:last-child) {
margin-right: 1rem;
}
.grow {
flex-grow: 1;
}
a {
color: var(--vp-c-brand);
}
</style>
3 changes: 3 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@ import DefaultTheme from "vitepress/theme";

// @ts-ignore
import BrowserPreview from "./components/BrowserPreview.vue";
// @ts-ignore
import ProjectCards from "./components/ProjectCards.vue";

import "./assets/styles.css";

export default {
extends: DefaultTheme,
enhanceApp(ctx) {
ctx.app.component('BrowserPreview', BrowserPreview);
ctx.app.component('ProjectCards', ProjectCards);
}
};
52 changes: 52 additions & 0 deletions docs/showcase/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
layout: page
---

<script setup>
const showcase = [
{
name: 'ESJS',
desc: 'Lenguaje de programación en Español',
link: 'https://es.js.org',
logo: 'https://es.js.org/assets/logo.png',
author: {
username: 'enzonotario',
link: 'https://github.com/enzonotario'
},
},
{
name: 'VIX',
desc: 'Boostrap your own web based CLI application',
link: 'https://henryhale.github.io/vix',
logo: 'https://henryhale.github.io/vix/xterminal.png',
author: {
username: 'henryhale',
link: 'https://github.com/henryhale'
},
},
{
name: 'TELEMATE',
desc: 'A small scale messaging application for devs',
link: 'https://github.com/henryhale/telemate',
logo: 'https://github.com/henryhale/telemate/raw/master/client/public/logo.svg',
author: {
username: 'henryhale',
link: 'https://github.com/henryhale'
},
},
{
name: 'DB-ADMIN',
desc: 'Interact with your databases in the browser',
link: 'https://github.com/henryhale/db-admin',
logo: 'https://github.com/henryhale/db-admin/raw/master/client/public/favicon.png',
author: {
username: 'henryhale',
link: 'https://github.com/henryhale'
},
},
];
</script>

<project-cards :projects='showcase'></project-cards>


36 changes: 18 additions & 18 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,30 +50,30 @@
"release": "release-it"
},
"devDependencies": {
"@babel/core": "^7.23.0",
"@babel/preset-env": "^7.22.20",
"@babel/core": "^7.23.6",
"@babel/preset-env": "^7.23.6",
"@rollup/plugin-babel": "^6.0.4",
"@rollup/plugin-replace": "^5.0.3",
"@rollup/plugin-replace": "^5.0.5",
"@rollup/plugin-terser": "^0.4.4",
"@typescript-eslint/eslint-plugin": "^6.7.4",
"@typescript-eslint/parser": "^6.7.4",
"@typescript-eslint/eslint-plugin": "^6.16.0",
"@typescript-eslint/parser": "^6.16.0",
"auto-changelog": "^2.4.0",
"autoprefixer": "^10.4.16",
"concurrently": "^8.2.1",
"cssnano": "^6.0.1",
"concurrently": "^8.2.2",
"cssnano": "^6.0.2",
"del-cli": "^5.1.0",
"eslint": "^8.50.0",
"eslint-plugin-prettier": "^5.0.0",
"eslint": "^8.56.0",
"eslint-plugin-prettier": "^5.1.2",
"husky": "^8.0.3",
"lint-staged": "^14.0.1",
"postcss": "^8.4.31",
"postcss-cli": "^10.1.0",
"prettier": "^3.0.3",
"release-it": "^16.2.1",
"rollup": "^3.29.4",
"typescript": "^5.2.2",
"vite": "^4.4.11",
"vitepress": "1.0.0-rc.4"
"lint-staged": "^15.2.0",
"postcss": "^8.4.32",
"postcss-cli": "^11.0.0",
"prettier": "^3.1.1",
"release-it": "^17.0.1",
"rollup": "^4.9.1",
"typescript": "^5.3.3",
"vite": "^5.0.10",
"vitepress": "1.0.0-rc.33"
},
"browserslist": [
"last 4 versions",
Expand Down
Loading

0 comments on commit 941f205

Please sign in to comment.