code.textmode.art (✿◠‿◠)

Official documentation, guides, and examples for textmode.js - a creative coding library for real-time ASCII art on the web.

🌐 Live site: code.textmode.art

What's inside

• 📚 Documentation - Installation guides, API reference, and tutorials
• 🎨 Examples - Interactive demos and code samples
• 🔤 Font showcase - Curated collection of compatible pixel fonts
• 🔌 Integrations - Guides for p5.js, Three.js, Hydra Synth, and more

Local development

To run this documentation site locally:

# Install dependencies
npm install

# Start dev server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Contributing

We welcome contributions! There are many ways to help:

• 🔤 Suggest fonts - Know a great pixel font? Add it to the showcase
• 🎨 Share sketches - Create example sketches for the documentation
• 📝 Improve docs - Better explanations, code examples, or tutorials
• 🐛 Report issues - Found a bug or typo? Let us know

All contributors are credited on the site. See CONTRIBUTING.md for details.

Tech stack

• VitePress - Static site generator
• vitepress-plugin-sandpack - Interactive code playgrounds
• vitepress-plugin-mermaid - Diagrams
• vitepress-plugin-blog - Blog functionality
• vitepress-plugin-codeblocks-fold - Collapsible code blocks
• vitepress-plugin-codesandbox - Open in CodeSandbox buttons on code blocks
• Giscus - Comments powered by GitHub Discussions

License

Documentation content is licensed under CC BY 4.0. Code examples are licensed under MIT.

Links

• 📦 textmode.js on npm
• 💻 textmode.js repository
• ✏️ textmode.js web editor
• 💬 Discord community