Skip to content

syntaxrecall/syntaxrecall

Repository files navigation

📚 Syntax Recall

Quick syntax reference with searchable code examples.

License: MIT PRs Welcome Built with Nuxt

View Live Site · Report Bug · Request Feature


✨ About

Quickly find syntax patterns and code snippets without digging through documentation or prompting AI to get the right output.

🚀 Getting Started

Prerequisites

Installation

# Clone the repository
git clone https://github.com/cadamsdev/syntaxrecall.git

# Navigate to the project directory
cd syntaxrecall

# Install dependencies
bun install

# Start the development server
bun dev

The app will be available at http://localhost:3000

Build for Production

bun generate

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated!

How to Contribute

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Adding a New Example

Examples are stored as Markdown files in /content/examples/. To add a new one:

  1. Create a new .md file in /content/examples/
  2. Add the required frontmatter (title, description, category, tags)
  3. Write your example content using proper Markdown formatting

See CONTENT_FORMAT.md for detailed formatting guidelines.

Ideas for Contributions

  • 📝 Add new examples (TypeScript, Go, Ruby, etc.)
  • 🔧 Add new developer tools
  • 🐛 Fix bugs or improve existing content
  • 🎨 Improve UI/UX
  • 📖 Improve documentation
  • 🌐 Add internationalization support

📁 Project Structure

syntaxrecall/
├── app/
│   ├── components/     # Vue components
│   ├── pages/          # Application pages
│   └── assets/         # Styles and static assets
├── content/
│   └── examples/       # Markdown example files
├── docs/               # Documentation
└── public/             # Public static files

🧰 Tech Stack

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

💖 Support

If you find this project helpful, please consider:

  • ⭐ Starring the repository
  • 🐛 Reporting bugs
  • 💡 Suggesting new features
  • 📣 Spreading the word

Made with ❤️ by the community

About

Your quick reference for syntax examples and productivity tools.

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Contributors 2

  •  
  •