rosiecampbell/eleventy-garden

:seedling: A starter site for building a mind garden in eleventy.

Eleventy-Garden

A starter site for building a mind garden, using 11ty.

Table of Contents

1. ✨ Features
2. 🚀 Getting Started
3. ❤️ Contribute
4. 📜 License

Note: I'm not building this project for myself, so y'all gotta tell me what you think. Issues are the way to go here.

✨ Features

• Supports double-bracket links (the ones roam uses)
• Mobile-friendly
• Displays backlinks
• View the demo

Planned

• annotations (#3)
• page preview on hover (#2)
• See the issue tracker for more

🚀 Getting Started

Questions? Open an issue!

First Steps

• Duplicate this repository by clicking Use this template above
• Clone the repository locally
• Run npm install in a terminal

Make your changes

• Styling: The css file is in /assets/style.css
• Branding: Add your logo or avatar in /assets/avatar.png
• Content: /_data/site.json contains vital information to make the site your own
  • Drop your notes in the /notes folder
• Testing: To view it locally, open a terminal and type npm start

Publish it

• You can use Netlify, Vercel, or whatever else works.

❤️ Contribute

Feel free to dive in!

Here's what this project needs...

• A readme illustration (like a banner)
• Contributors — even fixing typos on the redme is helpful.
• Feedback! I didn't make this repo is for myself, so y'all gotta tell me what you want.
• Stars on GitHub

Maintainers

@b3u

📜 Legal

This project is under the MIT license. Please adhere to the code of conduct.