Skip to content

Commit fc74a4d

Browse files
authored
feat: Scalar Docs 2.0 (#9)
* feat: update config to v2 * feat: add gha workflow * fix: logo * chore: update license * feat: update scalar galaxy example * docs: update introduction * docs: update content * docs: update content * Delete docs/content/configuration.md
1 parent df8c530 commit fc74a4d

File tree

15 files changed

+1409
-669
lines changed

15 files changed

+1409
-669
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Validate Scalar Configuration
2+
3+
on:
4+
# push to main
5+
push:
6+
branches:
7+
- main
8+
paths:
9+
- "scalar.config.json"
10+
- "docs/**"
11+
# pull requests
12+
pull_request:
13+
paths:
14+
- "scalar.config.json"
15+
- "docs/**"
16+
17+
jobs:
18+
validate:
19+
name: Validate scalar.config.json
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- name: Checkout repository
24+
uses: actions/checkout@v6
25+
26+
- name: Setup Node.js
27+
uses: actions/setup-node@v6
28+
with:
29+
node-version: "24"
30+
31+
- name: Validate
32+
run: npx @scalar/cli@latest project check-config

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2025 Scalar
3+
Copyright (c) 2023-present Scalar
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
[![Twitter](https://img.shields.io/twitter/follow/scalar)](https://x.com/scalar)
66
[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/scalar)
77

8-
Welcome to the Scalar Docs starter kit! This project provides you with a complete foundation to create beautiful, interactive API documentation using Scalar's powerful documentation platform.
8+
Welcome to the Scalar Docs Starter Kit! Deploy Markdown and OpenAPI documents from GitHub.
99

1010
## Preview
1111

12-
Use the Scalar CLI to render a live preview of your project locally:
12+
Use the [Scalar CLI](https://scalar.com/tools/cli/getting-started) to render a live preview of your project locally:
1313

1414
```bash
1515
npx @scalar/cli project preview
@@ -27,6 +27,10 @@ npx @scalar/cli project check-config
2727

2828
This will verify that your `scalar.config.json` file contains valid settings and help identify any configuration issues.
2929

30+
### GitHub Action
31+
32+
This repository includes a GitHub Action workflow that automatically validates the configuration on every push and pull request. See [`.github/workflows/validate-scalar-configuration.yml`](./.github/workflows/validate-scalar-configuration.yml).
33+
3034
## Project Structure
3135

3236
```

0 commit comments

Comments
 (0)