Modeling design decisions. Schemas, transformations, visualizations, the works.
We are an open collective of people dedicated to the design and software crafts: UX, design, code, web, 3d, audio, the works. Learn more about us and our projects at Noodlestan.org.
👐 Your contribution is welcome! 👐
If would like to share your ideas, report a bug, ask for improvements - or simply say hi! 👋 - don't hesitate to join us on Noodlestan's Discord or to drop us a line at [email protected].
System requirements:
We recommended using VS Code with the following extensions: ESLint, Prettier, MDX, Github Actions, Astro, SpellRight, Generate Index
First make sure you are using the correct node version by running nvm use.
Install dependencies with npm install.
Run a full build with npm run build:deps.
Run npm run dev in the docs directory: packages/docs/designer-docs/.
Libraries:
Cli tools:
Docs:
Support tools:
This component library targets any JS/TS stack. Packages are distributed both as TS modules and as CJS.
Documentation components and widgets are (for now) only available as Astro components, Starlight and distributed in source code only.
It uses:
Documentation is built on top of Astro / Starlight.
- Vite and Vitest
- @noodlestan/eslint-config - our style guide (ESLint + Prettier)
- Lefthook - manages the git hooks
Make sure the pre-commit hook was executed. It runs automatically before every commit and lints all code. Under the hood it runs npm run lint and npm run ci. Run these to inspect error details.
Copyright (c) 2024 Noodlestan.
Published under a MIT license.