Skip to content

Commit 2448681

Browse files
authored
Merge pull request #21787 from AnnsAnns/starlight_fix_for_the_fix
doc/starlight: Add temporary workaround to symlink issue
2 parents b04752e + 306f614 commit 2448681

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

doc/starlight/.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@ yarn-debug.log*
1212
yarn-error.log*
1313
pnpm-debug.log*
1414

15-
1615
# environment variables
1716
.env
1817
.env.production
1918

2019
# macOS-specific files
2120
.DS_Store
21+
22+
# Don't show copied files
23+
src/content/docs/**

doc/starlight/Makefile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,22 @@ install: integrate_outside_files
1010

1111
.PHONY: build
1212
build: install
13+
@echo "Copying RIOT documentation source files..."
14+
@echo "See: https://github.com/withastro/starlight/issues/3470"
15+
@rm -rf $(CURDIR)/src/content/docs
16+
@cp -r $(RIOTBASE)/doc/guides $(CURDIR)/src/content/docs
1317
@npm run build --prefix $(CURDIR)
1418
@echo "RIOT documentation successfully generated at file://$(RIOTBASE)/doc/starlight/dist/index.html"
1519

20+
.PHONY: preview
21+
preview: build
22+
@npm run preview --prefix $(CURDIR)
23+
1624
.PHONY: dev
1725
dev: install
26+
@echo "Linking RIOT documentation source files..."
27+
@rm -rf $(CURDIR)/src/content/docs
28+
@ln -s ../../../guides $(CURDIR)/src/content/docs
1829
@echo "Starting starlight live server..."
1930
@npm run dev --prefix $(CURDIR)
2031

doc/starlight/src/content/docs

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)