pen

محرر القلم

• العرض التوضيحي المباشر: http://sofish.github.io/pen
• يتم دعم التخفيض
• حالة البناء:

---

---

0. رمز المصدر

يمكنك استنساخ الرمز المصدر من Github ، أو باستخدام Bower.

 bower install pen

1. التثبيت

1.1 init مع سمة المعرف

 var editor = new Pen ( '#editor' ) ; 

1.2 init مع عنصر

 var editor = new Pen ( document . getElementById ( 'editor' ) ) ; 

1.3 init مع الخيارات

 var options = {
  editor : document . body , // {DOM Element} [required]
  class : 'pen' , // {String} class of the editor,
  debug : false , // {Boolean} false by default
  textarea : '<textarea name="content"></textarea>' , // fallback for old browsers
  list : [ 'bold' , 'italic' , 'underline' ] , // editor menu list
  linksInNewWindow : true // open hyperlinks in a new windows/tab
}

var editor = new Pen ( options ) ; 

2. تكوين

الكائن التالي يقوم بإعداد الإعدادات الافتراضية للقلم:

 defaults = {
  class : 'pen' ,
  debug : false ,
  textarea : '<textarea name="content"></textarea>' ,
  list : [
    'blockquote' , 'h2' , 'h3' , 'p' , 'insertorderedlist' , 'insertunorderedlist' ,
    'indent' , 'outdent' , 'bold' , 'italic' , 'underline' , 'createlink'
  ] ,
  stay : true ,
  linksInNewWindow : false
}

إذا كنت ترغب في تخصيص شريط الأدوات لتناسب مشروعك الخاص ، فيمكنك إنشاء مُنشئ Pen مع كائن options مثل #1.3: init مع الخيارات:

2.1 احتياطي للمتصفح القديم

يمكنك تعيين defaults.textarea على قطعة من سلسلة html ، افتراضيًا ، إنها <textarea name="content"></textarea> 。 سيتم تعيين هذا على أنه innerHTML من #editor الخاص بك.

2.2 تغيير فئة المحرر

سيضيف Pen .pen إلى المحرر بشكل افتراضي ، إذا كنت ترغب في تغيير الفصل ، تأكد من استبدال pen اسم الفصل الخاص بك في src/pen.css .

2.3 تمكين وضع التصحيح

إذا تم ضبط options.debug على true ، فسيقوم Pen بإخراج سجلات إلى وحدة التحكم في متصفحك.

2.4 تخصيص شريط الأدوات

يمكنك تعيين options.list على Array ، إضافة السلاسل التالية لجعل خاصتك:

• blockquote ، h2 ، h3 ، p ، pre : إنشاء علامة كمعنى حرفي لها
• insertorderedlist : إنشاء قائمة ol>li
• insertunorderedlist : إنشاء قائمة ul>li
• indent : قائمة المسافة البادئة / كتلة blockquote
• outdent : قائمة خارجية / كتلة blockquote
• bold : لف اختيار النص في علامة b
• italic : لف اختيار النص في علامة i
• underline : لف اختيار النص في علامة u
• createlink : أدخل الرابط لاختيار النص
• inserthorizontalrule : أدخل علامة hr
• insertimage : أدخل علامة صورة ( img )

2.5 أضف تلميحات الأدوات إلى أيقونات شريط الأدوات

يمكنك تعيين options.titles . سيتم استخدام قيمة كل خاصية كسمة العنوان على الرمز. ستعرض معظم المتصفحات سمة العنوان كملالية أدوات عندما يحوم الماوس فوق الرمز.

 options . title = {
    'blockquote' : 'Blockquote'
    'createlink' : 'Hyperlink'
    'insertimage' : 'Image'
}

إذا كنت تستخدم bootstrap أو jQueryui ، فيمكنك توحيد نمط تلميح الأدوات عن طريق إضافة $('i.pen-icon').tooltip() إلى JavaScript الخاص بك.

2.6 منع إعادة توجيه الصفحة غير الآمنة

بشكل افتراضي ، false PEN إعادة توجيه الصفحة غير الآمنة عند التحرير ، لإغلاقه ، options.stay محددة.

ملاحظة: إذا تم تعيين defaults.debug على true و default.stay لم يتم تعيينه: defaults.stay == !defaults.debug .

2.7 تعطيل وأعيد تمكين المحرر

يمكنك تعطيل محرر القلم عن طريق استدعاء destroy() طريقة var pen = new Pen(options) . يحب:

 var pen = new Pen ( '#editor' ) ;

pen . destroy ( ) ; // return itself

وهناك طريقة مقابلة تسمى rebuild() لإعادة تمكين المحرر:

 pen . rebuild ( ) ; // return itself 

2.8 محتوى التصدير على أنه تخفيض

إنها ميزة تجريبية

 var pen = new Pen ( '#editor' ) ;

pen . toMd ( ) ; // return a markdown string 

3. دعم بناء الجملة

3.1 تثبيت

سيتم تمكين محول بناء الجملة تلقائيًا عن طريق ربط markdown.js بعد `pen.js:

 < script src =" src/pen.js " > </ script >
< script src =" src/markdown.js " > </ script > 

3.2 الاستخدام

لاستخدامه ، يمكنك كتابة space key action cmd + Space في بدء السطر. يحب:

 ### This will create a h3 tag

يُسمح بـ CMDs التالية:

• العناوين: النوع 1 ~ 6 # في البداية
• القائمة غير المرتبة: اكتب - أو *
• القائمة المطلوبة: النوع 1.
• كتلة الكود: اكتب `` `
• اقتباس كتلة: اكتب >
• القاعدة الأفقية: أكثر من 3 - ، * ، . سيتم إنشاء <hr /> ، مثل ......

4. ترخيص

مرخصة تحت معهد ماساتشوستس للتكنولوجيا.

5. موثوق به من قبل *