Welcome to Awesome FAQ
A lightweight, no-database, easy-to-maintain FAQ system. Manage FAQs effortlessly with simple Markdown files.
🌟 Key Features
🚀 Lightweight
No databases, no complex setup. Just Markdown & Eleventy.
🛠️ Easy Maintenance
Update your FAQ by simply adding or editing Markdown files.
📖 Markdown-Based
Write FAQs in Markdown—Eleventy will convert them to HTML.
🌐 Open Source
Customize, extend, and contribute to the project on GitHub.
🚀 Getting Started
Follow these steps to set up your own Awesome FAQ.
1️⃣ Installation
# Clone the repository
git clone https://github.com/jiwon-lieb/faq_md.git
cd faq_md
# Install dependencies
yarn install
2️⃣ Build & Run
# Build the project
yarn build
# Start local development server
yarn start
3️⃣ Add Your FAQs
Add your Markdown FAQ files to the /faq directory.
Eleventy will automatically generate an FAQ page for you.