আমি কীভাবে মার্কডাউন নোটস বা ইনলাইন মন্তব্যগুলি থেকে ভিম ডকুমেন্টেশন তৈরি করতে পারি, বা ডকুমেন্টেশন যুক্ত করার আরও ভাল উপায় আছে?

Question

এটি একটির মধ্যে দুটি প্রশ্নের ধরণ । ইদানীং আমি গভীরভাবে উইমস্ক্রিপ্ট শিখতে, ভিমের ইন্টার্নাল শিখতে এবং ভিএম প্লাগিনগুলি লেখার জন্য আমার প্রথম পদক্ষেপ গ্রহণে অনেক সময় ব্যয় করছি। এই প্রক্রিয়া চলাকালীন, আমি স্বতন্ত্র মার্কডাউন ফাইলগুলিতে বিস্তৃত নোট রেখেছি এবং ভিমস্ক্রিপ্ট ফাইলগুলিতে প্রচুর ইনলাইন 'ডকুমেন্টেশন' মন্তব্য যুক্ত করেছি।

আমার মনে হচ্ছে অবশেষে আমার কাছে এমন কিছু কোড রয়েছে যা ভাগ করে নেওয়ার মতো, এবং কিছু প্রকৃত ডকুমেন্টেশন যুক্ত করা শুরু করতে চাই । আমি আমার নিজস্ব হেল্পডোক ফাইলগুলি এখনও রচনা করি নি, তাই আমি এখনও সেই প্রক্রিয়াটি সন্ধান করছি।

এই কর্মপ্রবাহ সম্পর্কে এখনও কোনও অভিজ্ঞতা বা দৃ understanding় বোঝা ছাড়াই, দুটি কাজ রয়েছে যা আমি বের করার চেষ্টা করছি:

1. আমার মার্কডাউন 'নোটস' ফাইল থেকে ভিআইএম / ভিমস্ক্রিপ্টে হেল্পডোক ফাইলগুলি তৈরি করা, যাতে আমি যে কোনও সময় ভিএম থেকে দ্রুত এবং সহজেই পড়তে / রেফারেন্স করতে পারি।
2. ভিমস্ক্রিপ্টগুলির সাথে সম্পর্কিত হেল্পডোকটি তৈরি করতে আমার উইমস্ক্রিপ্ট ফাইলগুলি ( শক্কো শেল স্ক্রিপ্টগুলির জন্য যেভাবে কাজ করে তার অনুরূপ) থেকে ইনলাইন ডকুমেন্টেশনগুলি পার্স করা ।

ধারণাগুলি সম্পর্কে কোনও পরামর্শ বা পরামর্শ ( এটি একটি খারাপ ধারণা কারণ ..., আরও ভাল ধারণা হ'ল ... ), বা কীভাবে সেগুলি সম্পাদন করা যায় তা প্রশংসা হবে।

Comments

যদিও আমি ভিএম এর সহায়তা ফাইলের ধরণের মার্কডাউন

— এভারগ্রিন

Answer 1

আমি যতদূর জানি যেহেতু উভয় সমস্যারই জন্য এখনই কোনও ভাল সমাধান নেই, তবে অনেক লোক তাদের সমাধানে আগ্রহী হবে।

মার্কডাউন এইচটিএমএল-এর একটি সুপারসেট, তাই আমি বলব যে মার্কডাউন থেকে ভিম সহায়তাতে রূপান্তর করার জন্য একটি সামনের পদ্ধতি সফল হওয়ার সম্ভাবনা কম। আপনি যদি হাস্কেল কথা বলতে পারেন তবে আপনি প্যান্ডোকের জন্য একটি ভিম সহায়তা ব্যাকএন্ড লেখার চেষ্টা করতে পারেন । এটি নিখুঁত না হলেও এটি খুব সুন্দর সমাধান হবে।

এটি অন্যান্য উপায়ে চেষ্টা করার জন্য কয়েকটি প্রচেষ্টা হয়েছে, ভিম সহায়তা পৃষ্ঠাগুলিকে কিছু দরকারী ফর্ম্যাটে রূপান্তর করুন। চারপাশে কয়েকটি স্ক্রিপ্ট ভাসমান রয়েছে যা বিভিন্ন সাফল্যের বিভিন্ন ডিগ্রী সহ অফিসিয়াল সাহায্যের এইচটিএমএল এবং পিডিএফ সংস্করণ তৈরি করে। তবে তারা সকলেই কমবেশি শৈলীতে সহায়তার উপর নির্ভর করে। প্যান্ডোকের মতো কোনও কিছুর জন্য এমনকি একটি ভিম সহায়তা পাঠকও একটি সার্থক প্রকল্প হতে পারে।

ভিম কোড থেকে ডকুমেন্টেশন আহরণের ক্ষেত্রে পাইথন, জাভাস্ক্রিপ্ট এবং ভিমএল-এর নিজেই ভিমলপারসার নামক ভিমএল-এর পার্সার রয়েছে । এটি বেশ ভাল, ভিএমএল উত্সকে বিশ্লেষণ করে বিশেষ কারুকাজ করা মন্তব্যগুলিকে ডাম্প করে এমন কিছু লেখা শক্ত হওয়া উচিত নয়। এই মন্তব্যগুলিকে এমন কিছুতে রূপান্তর করতে সক্ষম হওয়া, বলুন, পডও অত্যন্ত কার্যকর হবে।

Answer 2

html2vimdoc.py

আমি যে সর্বাধিক প্রতিশ্রুতিবদ্ধ সরঞ্জামটি পেয়েছি তা হ'ল html2vimdoc.pyএখানে http://peterodding.com/code/vim/tools এবং github এ পাওয়া যাবে । এটি মার্কডাউন এবং এইচটিএমএলকে ভিমের সহায়তা ফর্ম্যাটে রূপান্তর করতে পারে। বিজ্ঞাপনযুক্ত বৈশিষ্ট্যগুলি হ'ল:

• এটি [বিউটিফুলসপ] বিএসকে জটিল এইচটিএমএল ধন্যবাদ দিয়ে মোকাবেলা করতে পারে
• শিরোনামগুলির জন্য স্বয়ংক্রিয়ভাবে ভিম সহায়তা ফাইল ট্যাগ উত্পন্ন করে
• শিরোনাম এবং ট্যাগগুলি থেকে সামগ্রীর সারণী তৈরি করে
• নেস্টেড ব্লক স্ট্রাকচার যেমন নেস্টেড তালিকাগুলি, তালিকার অভ্যন্তরে প্রিফর্মেটেড ব্লকগুলি সমর্থন করে etc.
• যোগাযোগ আইটেমগুলি প্রতি তালিকা আইটেমের লাইনগুলির গড় সংখ্যার ভিত্তিতে তালিকাগুলি প্রসারিত করে

একটি পুরানো বিকল্প হ'ল https://github.com/mklabs/vim-markdown-helpfile

Https://superuser.com/q/415470/generating-help-files-for-vim- তেও আলোচনা হয়েছে