প্রকল্প সম্পর্কে
Ciderpress হলো মনোরেপোর জন্য ডিজাইন করা একটি ডকুমেন্টেশন ফ্রেমওয়ার্ক, যা ন্যূনতম কনফিগারেশনে markdown ফাইলগুলোকে একটি সম্পূর্ণ ডকুমেন্টেশন সাইটে রূপান্তর করে।
মূল সক্ষমতাসমূহ:
- কাঠামো মানানসইকরণ: কঠোর কাঠামো চাপিয়ে না দিয়ে আপনার বিদ্যমান রিপোজিটরি লেআউটের সাথে খাপ খায়।
- একীভূত কনফিগারেশন: সাইডবার, নেভিগেশন, ফুটার, এডিট লিংক, ভার্সন প্রদর্শন, ঘোষণা এবং থিমিং একটি একক কনফিগ ফাইল থেকে নিয়ন্ত্রিত হয়।
- বিল্ট-ইন থিম: চারটি থিমসহ আসে—honeycrisp, grannysmith, midnight, এবং arcade—প্রতিটিতে সম্পূর্ণ ডার্ক-মোড সমর্থন রয়েছে। কাস্টম থিমও সমর্থিত।
- মনোরেপো সমর্থন: ওয়ার্কস্পেস কার্ড, OpenAPI ইন্টিগ্রেশন এবং Liquid টেমপ্লেট সমর্থন অন্তর্ভুক্ত, যা অভ্যন্তরীণ ডেভেলপার ডকুমেন্টেশনকে লক্ষ্য করে।
ব্যবহারের জন্য npm-এর মাধ্যমে ইনস্টল করা এবং একটি কনফিগ ফাইল (ciderpress.config.ts) সংজ্ঞায়িত করা প্রয়োজন, যেখানে title, path এবং markdown include প্যাটার্নসহ সেকশন ঘোষণা করতে হয়। টুলটি তিনটি কমান্ড প্রদান করে: হট রিলোডসহ ডেভেলপমেন্ট সার্ভার শুরু করতে `npx ciderpress dev`, প্রোডাকশন বিল্ড তৈরি করতে `npx ciderpress build`, এবং বিল্ট সাইট স্থানীয়ভাবে প্রিভিউ করতে `npx ciderpress serve`।
MIT লাইসেন্সের অধীনে লাইসেন্সকৃত।
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.