Skip to content

Commit 29353b6

Browse files
committed
Initial release
0 parents  commit 29353b6

96 files changed

Lines changed: 4415 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/ci.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
lint-and-smoke:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout
12+
uses: actions/checkout@v4
13+
14+
- name: Stylua
15+
uses: JohnnyMorganz/stylua-action@v3
16+
with:
17+
token: ${{ secrets.GITHUB_TOKEN }}
18+
version: latest
19+
args: --check .
20+
21+
- name: Install Neovim
22+
run: |
23+
sudo apt-get update
24+
sudo apt-get install -y neovim
25+
26+
- name: Smoke test
27+
run: ./scripts/smoke.sh

.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Upstream checkout used for palette generation (not tracked)
2+
bearded-theme/
3+
4+
# Node / editor
5+
node_modules/
6+
.DS_Store
7+
8+
# Lua language server metadata
9+
.luarc.json
10+
11+
# Neovim artifacts
12+
.local/
13+
.cache/
14+
15+
# Generated helptags
16+
doc/tags
17+
18+
# nvim log
19+
.nvimlog

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# 🤝 Contributing to bearded-nvim
2+
3+
Thanks for your interest! This project mirrors the upstream VS Code Bearded Theme palettes and ships a Neovim colorscheme with integrations.
4+
5+
## Workflow
6+
7+
- 🧭 Clone the upstream VS Code theme to pull palettes: <https://github.com/BeardedBear/bearded-theme>
8+
- 🌉 Point `BEARDED_THEME_PATH` to that clone when regenerating.
9+
- 🔄 Regenerate palettes/stubs when upstream changes:
10+
11+
```bash
12+
BEARDED_THEME_PATH=/path/to/bearded-theme ./scripts/regen.sh
13+
```
14+
15+
- 🧹 Format Lua:
16+
17+
```bash
18+
stylua .
19+
```
20+
21+
- 🧪 Smoke test (headless load):
22+
23+
```bash
24+
./scripts/smoke.sh
25+
```
26+
27+
## PR checklist
28+
29+
- [ ] 🔄 Palettes regenerated if upstream changed
30+
- [ ] 🧹 Stylua clean
31+
- [ ] 🧪 Smoke test passes
32+
- [ ] 📝 Highlight changes documented in the PR
33+
34+
## Reporting issues
35+
36+
- 🐛 Include Neovim version (`nvim --version`), flavor slug, and screenshots if it’s a visual issue.
37+
38+
## Requirements
39+
40+
- 🐍 Python 3 (for palette export/generation)
41+
- 🛰️ Neovim in PATH (for `scripts/smoke.sh`)
42+
- 🧹 Stylua (formatter)
43+
- 🌉 Access to the upstream repo (cloned locally) for palette regeneration
44+
45+
## License
46+
47+
- 📝 GPL-3.0-only (see LICENSE)

0 commit comments

Comments
 (0)