Skip to content

Commit ee9efc7

Browse files
authored
docs: add Documenter.jl documentation system (#288)
Set up comprehensive documentation using Documenter.jl with the following structure: - Getting started guide (VSCode and other editors) - User guide (configuration, formatting, TestRunner integration) - Communication channels documentation Key changes: - Create `docs/` directory with structured markdown documentation - Add `docs/make.jl` for building documentation with Documenter.jl - Set up GitHub Actions workflow for automated documentation deployment - Move screenshot assets from `assets/` to `docs/src/assets/` - Implement theme-aware image switching (light/dark mode) using custom CSS - Add support for Catppuccin themes (Frappé, Macchiato, Mocha) - Update README.md to focus on development information and link to docs - Add documentation badge to README.md - Update .gitignore to exclude docs/build/ directory The documentation is now available at https://aviatesk.github.io/JETLS.jl/dev/ and provides a better user experience with proper navigation, search functionality, and theme support.
1 parent 98013ac commit ee9efc7

24 files changed

+2109
-551
lines changed

.github/workflows/docs.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master # update to match your development branch (master, main, dev, trunk, ...)
7+
tags: '*'
8+
pull_request:
9+
10+
jobs:
11+
build:
12+
# These permissions are needed to:
13+
# - Deploy the documentation: https://documenter.juliadocs.org/stable/man/hosting/#Permissions
14+
# - Delete old caches: https://github.com/julia-actions/cache#usage
15+
permissions:
16+
actions: write
17+
contents: write
18+
pull-requests: read
19+
statuses: write
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
- uses: julia-actions/setup-julia@v2
24+
with:
25+
version: '1'
26+
- uses: julia-actions/cache@v2
27+
- name: Install dependencies
28+
shell: julia --color=yes --project=docs {0}
29+
run: |
30+
using Pkg
31+
Pkg.develop(PackageSpec(path=pwd()))
32+
Pkg.instantiate()
33+
- name: Build and deploy
34+
run: julia --color=yes --project=docs docs/make.jl
35+
env:
36+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
37+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ Manifest-*.toml
55
.envrc
66
**/.JETLSConfig.toml
77
*.vsix
8+
docs/build/

0 commit comments

Comments
 (0)