Skip to content

Commit

Permalink
improve website
Browse files Browse the repository at this point in the history
  • Loading branch information
pomdtr committed Nov 5, 2023
1 parent b177a8d commit c9c7bef
Show file tree
Hide file tree
Showing 61 changed files with 2,300 additions and 419 deletions.
68 changes: 68 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages

on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
push:
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
# - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
# - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 18
cache: npm # or pnpm / yarn
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install dependencies
working-directory: docs
run: npm ci # or pnpm install / yarn install / bun install
- name: Build with VitePress
working-directory: docs
run: |
npm run build # or pnpm docs:build / yarn docs:build / bun run docs:build
touch docs/.vitepress/dist/.nojekyll
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: docs/.vitepress/dist

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
go-version: ">=1.19.4"
cache: true
- name: Render install script
run: m4 -D "TAG=$GITHUB_REF_NAME" < install.tpl.sh > install.sh
run: m4 -D "TAG=$GITHUB_REF_NAME" < scripts/install.tmpl.sh > install.sh
- uses: goreleaser/goreleaser-action@v4
with:
# either 'goreleaser' (default) or 'goreleaser-pro':
Expand Down
104 changes: 0 additions & 104 deletions .github/workflows/web.yml

This file was deleted.

5 changes: 3 additions & 2 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
},
"yaml.validate": false,
"deno.enablePaths": [
"./catalog",
"./cmd/templates"
"./extensions",
"./cmd/templates",
"./scripts"
]
}
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ Sunbeam is a general purpose command-line launcher.
Define UIs composed of a succession of views from simple scripts written in any language.

<p align="center" style="text-align: center">
<a href="https://asciinema.org/a/614506">
<img src="https://asciinema.org/a/614506.svg">
</a>
<img style="border-radius: 10px;" src="./docs/assets/demo.gif">
</p>

You can think of it as a mix between an application launcher like [raycast](https://raycast.com) or [rofi](https://github.com/davatorium/rofi) and a fuzzy-finder like [fzf](https://github.com/junegunn/fzf) or [telescope](https://github.com/nvim-telescope/telescope.nvim).
Expand All @@ -16,7 +14,7 @@ You can think of it as a mix between an application launcher like [raycast](http

Sunbeam is distributed as a single binary, available for all major platforms. Sunbeam also comes with a lot of utilities to make it easy to create cross-platform scripts.

![sunbeam running in hyper](./static/hyper.jpeg)
![sunbeam running in hyper](./docs/assets/hyper.jpeg)

## Supports any language

Expand All @@ -33,4 +31,4 @@ It is trivial to integrate sunbeam with existings apps since it's just a command

More information in the [integrations](https://pomdtr.github.io/sunbeam/book/user-guide/integrations.html) section.

![sunbeam running in vscode](./static/vscode.png)
![sunbeam running in vscode](./docs/assets/vscode.png)
10 changes: 0 additions & 10 deletions book.toml

This file was deleted.

69 changes: 0 additions & 69 deletions catalog/extensions/github.sh

This file was deleted.

1 change: 1 addition & 0 deletions cmd/extension.go
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,7 @@ func NewCmdExtensionRemove() *cobra.Command {
if err := os.RemoveAll(extensionDir); err != nil {
return err
}
cmd.Println("Removed", alias)
}

return nil
Expand Down
10 changes: 9 additions & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ See https://pomdtr.github.io/sunbeam for more information.`,
return err
}

fmt.Println(doc)
fmt.Printf("# CLI\n\n%s\n", doc)
return nil
},
}
Expand Down Expand Up @@ -182,6 +182,14 @@ func buildDoc(command *cobra.Command) (string, error) {
}

for _, child := range command.Commands() {
if child.GroupID == CommandGroupExtension {
continue
}

if child.Hidden {
continue
}

childPage, err := buildDoc(child)
if err != nil {
return "", err
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/
.vitepress/cache/
Loading

0 comments on commit c9c7bef

Please sign in to comment.