Skip to content

Commit 539c848

Browse files
Copilothuangyiirene
andcommitted
Fix validation script for starter template
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent 50c7e5c commit 539c848

3 files changed

Lines changed: 27 additions & 63 deletions

File tree

examples/starter/validate.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
set -e
66

77
echo "================================================"
8-
echo "ObjectDocs Example Project - Validation Script"
8+
echo "ObjectDocs Starter Template - Validation Script"
99
echo "================================================"
1010
echo ""
1111

@@ -15,9 +15,9 @@ GREEN='\033[0;32m'
1515
YELLOW='\033[1;33m'
1616
NC='\033[0m' # No Color
1717

18-
# Check if we're in the example directory
19-
if [ ! -f "package.json" ] || ! grep -q "objectdocs-example" package.json; then
20-
echo -e "${RED}Error: This script must be run from the example directory${NC}"
18+
# Check if we're in the starter directory
19+
if [ ! -f "package.json" ] || ! grep -q "objectdocs-starter" package.json; then
20+
echo -e "${RED}Error: This script must be run from the examples/starter directory${NC}"
2121
exit 1
2222
fi
2323

packages/site/docs.site.json

Lines changed: 13 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,23 @@
11
{
2-
"meta": {
3-
"title": "ObjectDocs",
4-
"description": "The Metadata-Driven Documentation Engine for the Low-Code Era.",
5-
"url": "https://docs.objectstack.ai",
6-
"favicon": "/favicon.ico"
7-
},
8-
"i18n": {
9-
"enabled": true,
10-
"defaultLanguage": "en",
11-
"languages": ["en", "cn"
12-
]
13-
},
142
"branding": {
3+
"name": "ObjectDocs Starter",
154
"logo": {
16-
"text": "ObjectDocs",
175
"light": "/logo.svg",
18-
"dark": "/logo.svg"
19-
},
20-
"theme": {
21-
"accentColor": "blue",
22-
"radius": "0.5rem"
6+
"dark": "/logo-dark.svg"
237
}
248
},
25-
"layout": {
26-
"navbar": {
27-
"enabled": true,
28-
"transparentMode": "top",
29-
"links": [
30-
{
31-
"text": "Home",
32-
"url": "https://www.objectstack.ai",
33-
"external": true
34-
}
35-
],
36-
"socials": [
37-
{ "platform": "github", "url": "https://github.com/objectstack-ai" }
38-
]
39-
},
40-
"sidebar": {
41-
"enabled": true,
42-
"prefetch": true,
43-
"defaultOpenLevel": 1,
44-
"collapsible": true,
45-
"tabs": []
9+
"links": [
10+
{
11+
"text": "Documentation",
12+
"url": "/docs"
4613
},
47-
"toc": {
48-
"enabled": true,
49-
"depth": 3
50-
},
51-
"footer": {
52-
"enabled": false,
53-
"copyright": "© 2026 ObjectStack Inc."
54-
}
55-
},
56-
"page": {
57-
"showLastUpdate": true,
58-
"showEditLink": true,
59-
"repoBaseUrl": "https://github.com/objectstack-ai/objectdocs"
60-
},
61-
"content": {
62-
"math": false,
63-
"imageZoom": true,
64-
"codeBlock": {
65-
"theme": "vesper",
66-
"showLineNumbers": true
14+
{
15+
"text": "GitHub",
16+
"url": "https://github.com/objectstack-ai/objectdocs",
17+
"icon": "github"
6718
}
19+
],
20+
"build": {
21+
"output": "standalone"
6822
}
6923
}

packages/site/public/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Logo Files
2+
3+
Place your logo files here:
4+
5+
- `logo.svg` - Logo for light mode
6+
- `logo-dark.svg` - Logo for dark mode
7+
8+
These files are referenced in `content/docs.site.json`.
9+
10+
If you don't have custom logos, the site will display the text-based branding name instead.

0 commit comments

Comments
 (0)