फ्लैटपेज उपयोग दस्तावेज

फ्लैटपेज एक सरल और शक्तिशाली स्थिर पृष्ठ प्रबंधन प्रणाली है जो मार्कडाउन प्रारूप में सामग्री लेखन का समर्थन करती है, स्वचालित रूप से निर्देशिकाएं उत्पन्न करती है, और एक सौंदर्य रीडिंग इंटरफ़ेस प्रदान करती है।

कार्यात्मक विशेषताएं

• सामग्री लिखने के लिए मार्कडाउन प्रारूप का समर्थन करता है
• स्वचालित रूप से लेख कैटलॉग उत्पन्न करें
• कोड हाइलाइटिंग
• प्रगति निर्देश पढ़ें
• उत्तरदायी डिजाइन, मोबाइल के लिए समर्थन
• समर्थन लेख नेविगेशन (पिछला/अगला)
• समर्थन लेख खोज
• अंतर्राष्ट्रीय समर्थन

का उपयोग कैसे करें

1। कॉन्फ़िगरेशन सक्षम करें

कॉन्फ़िगरेशन फ़ाइल में फ्लैटपेज सक्षम करें:

[flatpages] 
    # 是否启用flatpages 
    enable = true 
    # 支持配置多个flatpage目录 
    [[flatpages.dirs]] 
        nav_name = "帮助文档" 
        nav_path = "docs" 
        file_path = "statics/flatpages/docs" 
        # 每页显示的条目数，可选，默认为10 
        page_size = 20 
 
    # 可以继续添加更多目录配置... 

2। एक लेख बनाएं

statics/flatpages निर्देशिका में एक .md फ़ाइल बनाएं, और इसे निम्न प्रारूप में लिखें:

# 文章标题 
 
> 文章描述（会显示在列表页） 
 
正文内容... 
 
## 二级标题 
 
### 三级标题 
 
正文内容... 

3। मार्कडाउन प्रारूप विवरण

फ्लैटपेज मानक मार्कडाउन सिंटैक्स का समर्थन करता है, जिसमें शामिल हैं:

• शीर्षक (H1-H4)
• सूची (आदेशित और अनियंत्रित)
• कोड ब्लॉक (सिंटैक्स हाइलाइटिंग का समर्थन करता है)
• संदर्भ खंड
• जोड़ना
• चित्र
• इनलाइन कोड

कोड ब्लॉक उदाहरण:

def hello(): 
    print("Hello, World!") 

4। विशेष कार्य

कोड प्रति

कोड को कॉपी करने के लिए उपयोगकर्ताओं को सुविधाजनक बनाने के लिए सभी कोड ब्लॉकों के ऊपरी दाएं कोने में कॉपी बटन को स्वचालित रूप से जोड़ा जाएगा।

निर्देशिका नेविगेशन

सिस्टम स्वचालित रूप से लेख (H2-H4) के शीर्षक के आधार पर एक निर्देशिका उत्पन्न करेगा और इसे दाईं ओर प्रदर्शित करेगा। निर्देशिका समर्थन:

• वर्तमान पढ़ने की स्थिति को स्वचालित रूप से हाइलाइट करें
• कूदने के लिए क्लिक करें
• स्क्रॉल सिंक्रनाइज़ेशन

पठन प्रगति

एक पठन प्रगति बार पृष्ठ के शीर्ष पर प्रदर्शित किया जाएगा, जो नेत्रहीन रूप से पढ़ने की स्थिति प्रदर्शित करेगा।

कार्यान्वयन सिद्धांत

1। फ़ाइल प्रणाली

फ्लैटपेज स्थैतिक फ़ाइलों का प्रबंधन करने के लिए GO के embed.FS का उपयोग करता है:

//go:embed flatpages/* 
var Files embed.FS 

2। रूटिंग पंजीकरण

सिस्टम स्टार्टअप में InitFlatpages फ़ंक्शन के माध्यम से संबंधित मार्गों को पंजीकृत करता है:

• /fp/ - अनुच्छेद सूची पृष्ठ
• /fp/:slug - अनुच्छेद विवरण पृष्ठ

3। मार्कडाउन विश्लेषण

मार्कडाउन पार्सिंग के लिए gomarkdown/markdown पैकेज का उपयोग करें, समर्थन:

• कमान -पत्र
• ऑटोहेडिंगिड्स
• Hreftargetblank

4। अनुच्छेद प्रबंधन

सभी मार्कडाउन फ़ाइलों को स्टार्टअप पर लोड किया जाएगा:

1. URL स्लग के रूप में फ़ाइल नाम को हल करें
2. लेख शीर्षक (H1) निकालें
3. लेख विवरण (पहला उद्धरण ब्लॉक) निकालें
4. पढ़ने के समय की गणना करें
5. रिकॉर्ड अद्यतन समय

5। खोज कार्यान्वयन

सूची पृष्ठों का खोज फ़ंक्शन जावास्क्रिप्ट में लागू किया गया है, जो शीर्षक और विवरणों की वास्तविक समय की खोज का समर्थन करता है।

6। अंतर्राष्ट्रीय समर्थन

सिस्टम I18N समर्थन को एकीकृत करता है, और बहुभाषी समर्थन कॉन्फ़िगरेशन के माध्यम से सक्षम किया जा सकता है:

[i18n] 
enable = true 

सर्वोत्तम प्रथाएं

1. फ़ाइल नामकरण
   • एक सार्थक फ़ाइल नाम का उपयोग करें, जिसका उपयोग URL के हिस्से के रूप में किया जाएगा
   • विशेष पात्रों और रिक्त स्थान से बचें
   • लोअरकेस अक्षरों और हाइफ़न की सिफारिश की जाती है
2. सामग्री संगठन
   • प्रत्येक फ़ाइल में H1 शीर्षक होना चाहिए
   • लेख विवरण जोड़ने के लिए उद्धरण ब्लॉकों का उपयोग करें
   • सामग्री को व्यवस्थित करने के लिए माध्यमिक और तीसरे स्तर के शीर्षक का यथोचित उपयोग करें
   • एकल फ़ाइल के आकार को नियंत्रित करें, यह 1000 लाइनों से अधिक नहीं करने की सिफारिश की जाती है।
3. मूर्ति प्रोद्योगिकी
   • चित्रों को statics/img निर्देशिका में संग्रहीत करने की सिफारिश की जाती है
   • सापेक्ष पथों का उपयोग करके संदर्भ चित्र
   • लोडिंग गति बढ़ाने के लिए छवियों को संपीड़ित करें
4. कोड प्रदर्शन
   • सही सिंटैक्स हाइलाइटिंग प्राप्त करने के लिए कोड ब्लॉक की भाषा निर्दिष्ट करें
   • महत्वपूर्ण कोड में टिप्पणियाँ जोड़ें
   • सुनिश्चित करें कि कोड ब्लॉक सही ढंग से इंडेंट किया गया है

समस्या निवारण

1. पृष्ठ प्रदर्शित नहीं किया गया
   • जांचें कि क्या flatpages.enable कॉन्फ़िगरेशन फ़ाइल में सही है
   • पुष्टि करें कि मार्कडाउन फ़ाइल सही निर्देशिका में है
2. निर्देशिका उत्पन्न नहीं हुई
   • जांच करें कि क्या लेख में एक माध्यमिक या तृतीयक शीर्षक है
   • पुष्टि करें कि शीर्षक सही है (## या ###)
3. शैली अपवाद
   • जांचें कि क्या मार्कडाउन सिंटैक्स सही है
   • फ़ाइल एन्कोडिंग की पुष्टि करें UTF-8 है
4. अमान्य खोज
   • जावास्क्रिप्ट त्रुटियों के लिए ब्राउज़र कंसोल की जाँच करें
   • पुष्टि करें कि पृष्ठ जावास्क्रिप्ट सही तरीके से लोड होता है