README ফাইলগুলি আপডেট করার সময় আমি গিথুব দ্বারা ব্যবহৃত লাইটওয়েট মার্কআপ ভাষার সাথে খুব বেশি পরিচিত নই।
আমার ওপেন সোর্স লাইব্রেরির README / উইকি ফাইলগুলির জন্য উপযুক্ত মার্কআপ সিনট্যাক্সটি কীভাবে লিখতে হবে সেগুলি সম্পর্কে আমি কোথায় পড়তে পারি?
এবং এমন একটি সরঞ্জাম আছে যা আমি আমার গিথুব সংগ্রহস্থলে আপডেট হওয়া পুনরায় পাঠানোর আগে "আমার ব্রাউজারে আমার ডক্স স্থানীয়ভাবে পর্যালোচনা" করতে পারি?
উত্তর:
প্রশ্নযুক্ত মার্কআপটিকে কাকতালীয়ভাবে মার্কডাউন বলা হয় , এটি ডেয়ারিং ফায়ারবল ব্লগের লেখক জন গ্রুবার তৈরি করেছিলেন । মার্কডাউনের মূল উত্সটি ডেয়ারিং ফায়ারবল - মার্কডাউন থেকে পাওয়া যাবে ।
অনেক মার্কডাউন উপভাষা রয়েছে, গিথুব-এর জন্য ডকুমেন্টেশনগুলি গিথুব স্বাদযুক্ত মার্কডাউন পৃষ্ঠায় পাওয়া যাবে ।
এই পৃষ্ঠা থেকে দুর্দান্ত টিপ:
চিটপত্রটি প্রকাশের জন্য মার্কডাউন সম্পাদকের সাহায্যে যে কোনও গিথুব পৃষ্ঠায় এম চাপুন ।
আপনার মার্কডাউন ডকুমেন্টগুলি পরীক্ষা করতে আপনি গিথব মার্কডাউন লাইভ পূর্বরূপ পৃষ্ঠাটিও ব্যবহার করতে পারেন ।
আপডেট 2012-11-08 : মার্কডাউন সিনট্যাক্সকে মানক করার চেষ্টা চলছে। মার্কডাউন এর ফিউচার দেখুন - জেফ আতউড, কোডিং হরর এবং ডাব্লু 3 সি মার্কডাউন কমিউনিটি গ্রুপ ।
আপডেট 2014-09-09 : কমনমার্ক একটি মার্কডাউন স্ট্যান্ডার্ড এবং স্পেক প্রকাশিত হয়েছে।
( কিছু উত্তর দিয়ে এই উত্তরটি পুনরায় পোস্ট করা )
গেমটি থেকে একটু দেরি হলেও পাইথনে আমি একটি ছোট সি এল এল লিখেছি। এটিকে গ্রিপ (গিথুব রেডমে তাত্ক্ষণিক পূর্বরূপ) বলা হয় । প্যাট্রিকের উত্তরে যুক্ত করা, এটি আপনাকে "আমার ব্রাউজারে স্থানীয়ভাবে আমার দস্তাবেজগুলি পর্যালোচনা করতে" দেবে।
এটি দিয়ে এটি ইনস্টল করুন:
$ pip install grip
এবং এটি সহজভাবে ব্যবহার করতে:
$ grip
তারপরে সেই স্থানে ফাইলটি localhost:5000দেখতে যান readme.md।
আপনি নিজের ফাইলটি নির্দিষ্ট করতে পারেন:
$ grip CHANGES.md
এবং বন্দরটি পরিবর্তন করুন:
$ grip 8080
বা পূর্ববর্তী দুটি একত্রিত করুন:
$ grip CHANGES.md 8080
এমনকি গিটহাব-স্বাদযুক্ত মার্কডাউন (যেমন কীভাবে মন্তব্য এবং সমস্যাগুলি উপস্থাপন করা হয়) রেন্ডার করতে পারেন, বিকল্পভাবে অটো-হাইপারলিংক রেফারেন্সের রেপো প্রসঙ্গে অন্যান্য ইস্যুতে:
$ grip --gfm --context=username/repo issue.md
বংশবৃদ্ধির জন্য, সিএলআই সহায়তা ব্যবহার করে বাকী বিকল্পগুলি এবং তাদের বিশদটি দেখুন:
$ grip -h
উল্লেখযোগ্য বৈশিষ্ট্য:
আশাকরি এটা সাহায্য করবে. এটি পরীক্ষা করে দেখুন ।
এখানে একটি দুর্দান্ত অনলাইন / লাইভ সম্পাদক রয়েছে:
http://jbt.github.io/markdown-editor/
Previewগিটহাবে একটি বোতামও রয়েছে।
নীচের স্ক্রিনশটে দেখুন যে এই বোতামটি প্রদর্শিত হবে যখন আমি সম্পাদনা ক্লিক করব README.md।
আইএমএইচও লাইভ এডিটর গিটহাবের বর্তমানের চেয়ে আরও ভাল।
হালনাগাদ
ঠিক এখনই আমি অনুসন্ধান Markdownএবং ভিজ্যুয়াল স্টুডিওর সন্ধানের পরে খুঁজে পেয়েছি যে আপনি যদি ভিএস ব্যবহার করেন তবে আপনি ওয়েব এসেন্সিয়াল ইনস্টল করতে পারেন এবং Markdownভিজ্যুয়াল স্টুডিওর মধ্যে থেকেই সমর্থন পেতে পারেন । চমৎকার!
ইহা ছিল:
এটি সম্পর্কে বিশদ এখানে ।
নোট করুন যে ফেব্রুয়ারী ২০১৪ সাল থেকে " রেন্ডারড গদ্য ডিফস " দিয়ে আপনি একটি মার্কডাউন ফাইলে একটি ডিফের রেন্ডার সংস্করণটিও দেখতে পাবেন:
গদ্য ফাইলগুলি সহ কমিট এবং টানুন অনুরোধগুলি এখন উত্স এবং রেন্ডার দর্শনগুলি বৈশিষ্ট্যযুক্ত করে ।
অ-পাঠ্য পরিবর্তনগুলি একটি নিম্ন-কী ডটেড আন্ডারলাইন সহ উপস্থিত হয়। কী পরিবর্তিত হয়েছে তা দেখতে পাঠ্যের উপর ঘুরে দেখুন:
আরেকটি বিকল্প - গিথুবের নতুন পাঠ্য সম্পাদক, এটম এটি সম্পাদনা করার সাথে সাথে গিথুব-স্বাদযুক্ত মার্কডাউন রেন্ডার করবে। Https://atom.io/ দেখুন
এটি দীর্ঘমেয়াদে (বিয়ারের মতো) মুক্ত হবে কিনা তা সম্পর্কে আমি নিশ্চিত নই।
অন্যান্য সরঞ্জামগুলি যথেষ্ট ভাল ছিল তা আমি খুঁজে পাইনি - আমি চেয়েছিলাম:
এটিই আমি শেষ পর্যন্ত স্থায়ী করে: https://github.com/ypocat/gfms
> gfms
Github Flavored Markdown Server.
Run in your project's root directory.
Usage: gfms
Options:
-p, --port Port number to listen at. [required]
-h, --host Host address to bind to. [default: "localhost"]
--proxy if behind a proxy, proxy url.
-a, --api Render using Github API.
-n, --no-api-on-reload Disable usage of Github API when the doc is manually reloaded.
সুতরাং আমি অপরিবর্তিত করেছি:
alias gm='gfms -a -p 8070'
-pবিকল্পটি ব্যবহার করা গিথুব এপিআইতে হিট হয় এবং আসল, বর্তমান গিথুব সিএসএস ব্যবহার করে যাতে কোনও আশ্চর্য হওয়ার দরকার নেই।