GitHub - synlace/project-docs: Starlight documentation scaffold for any project · GitHub
/" data-turbo-transient="true" />
Skip to content
Search or jump to...
Search code, repositories, users, issues, pull requests...
-->
Search
Clear
Search syntax tips
Provide feedback
--><br>We read every piece of feedback, and take your input very seriously.
Include my email address so I can be contacted
Cancel
Submit feedback
Saved searches
Use saved searches to filter your results more quickly
-->
Name
Query
To see all available qualifiers, see our documentation.
Cancel
Create saved search
Sign in
/;ref_cta:Sign up;ref_loc:header logged out"}"<br>Sign up
Appearance settings
Resetting focus
You signed in with another tab or window. Reload to refresh your session.<br>You signed out in another tab or window. Reload to refresh your session.<br>You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading. Please reload this page.
synlace
project-docs
Public
Notifications<br>You must be signed in to change notification settings
Fork
Star
main
BranchesTags
Go to file
CodeOpen more actions menu
Folders and files<br>NameNameLast commit message<br>Last commit date<br>Latest commit
History<br>17 Commits<br>17 Commits
project-docs
project-docs
.gitignore
.gitignore
LICENSE
LICENSE
README.md
README.md
init.sh
init.sh
justfile-doc
justfile-doc
View all files
Repository files navigation
project-docs
Starlight documentation scaffold for any project.
One command to add a searchable, themed documentation site to your repo.
Usage
curl -fsSL https://github.com/synlace/project-docs/raw/main/init.sh | bash
To get the latest SHA, check the latest commit.
What you get
project/<br>├── project-docs/ # Starlight docs site<br>│ ├── package.json<br>│ ├── astro.config.mjs # edit title, sidebar, social links<br>│ └── src/content/docs/ # your documentation pages<br>│ └── index.mdx<br>├── justfile-doc # just recipes (import into justfile)<br>└── justfile # auto-created with import if missing
Features
Dark / light mode
Full-text search
Sidebar navigation
Mermaid diagrams
Mobile responsive
Static HTML output (npm run build)
just recipes
Once imported, run from your project root:
Command<br>Description
just doc<br>Start dev server
just doc init<br>Install npm dependencies
just doc build<br>Build static site
just doc preview<br>Preview production build
just doc uninstall<br>Remove scaffold and import
How it works
The template is downloaded as a tarball from GitHub. No submodules, no npm publishing, no build service. Each project owns its project-docs/ directory — edits config, writes content, commits everything to its own repo.
Updating
The template is a starting point, not a dependency. To pull in config improvements later:
SHA=$(curl -fsSL https://api.github.com/repos/synlace/project-docs/commits/main | python3 -c "import sys,json; print(json.load(sys.stdin)['sha'][:7])")<br>diff -rq project-docs/ curl -fsSL "https://github.com/synlace/project-docs/archive/$SHA.tar.gz" | tar -xz --strip-components=1)
Cherry-pick what you want.
About
Starlight documentation scaffold for any project
Resources
Readme
License
MIT license
Uh oh!
There was an error while loading. Please reload this page.
Activity
Custom properties
Stars
stars
Watchers
watching
Forks
forks
Report repository
Releases
No releases published
Packages
Uh oh!
There was an error while loading. Please reload this page.
Contributors
Uh oh!
There was an error while loading. Please reload this page.
Languages
Shell<br>40.1%
JavaScript<br>36.2%
MDX<br>20.1%
TypeScript<br>3.6%
You can’t perform that action at this time.