Mkdocs, இந்த திறந்த மூல மென்பொருளுக்கு ஆவணங்களை உருவாக்கவும்

அடுத்த கட்டுரையில் நாம் Mkdocs ஐப் பார்க்கப் போகிறோம். நீங்கள் மென்பொருளை உருவாக்கி நாடினால் ஆவணங்களை உருவாக்குவதற்கான ஒரு தளம் உங்கள் திட்டங்களில் ஒன்று. அல்லது ஊழியர்களுக்கான உள் ஆவணங்களை உருவாக்க வேண்டிய ஒரு நிறுவனத்தில் நீங்கள் பணிபுரிந்தால். நீங்கள் சில குறிப்புகளைச் சேமிக்க விரும்பும் மேம்பட்ட பயனராக இருந்தாலும் கூட. MkDocs என்பது நீங்கள் முயற்சிக்க வேண்டிய ஒரு கருவி.

இந்த மென்பொருள் ஆவண தளங்களை உருவாக்குவதை நோக்கமாகக் கொண்ட ஒரு நிலையான தள ஜெனரேட்டராகும். இது மிகவும் எளிமையானது, பார்ப்பதற்கு அழகாக இருக்கிறது, மேலும் அமைக்கவும் வரிசைப்படுத்தவும் எளிதானது. இருக்கிறது மலைப்பாம்பில் எழுதப்பட்டது மற்றும் வெறுமனே உங்கள் கோப்புகளை மார்க் டவுன் வடிவத்தில் உருவாக்க வேண்டும். பின்னர், ஒற்றை YAML உள்ளமைவு கோப்பைப் பயன்படுத்தி, உங்களுக்காக வேலை செய்யும் நிலையான வலைத்தளத்தை உருவாக்கலாம்.

MkDocs ஐப் பயன்படுத்தி ஒரு முழுமையான ஆவணமாக்க வலைத்தளத்தைப் பெறுவது எவ்வளவு எளிது என்பதை அடுத்து பார்ப்போம். இன்னும் பலர் உள்ளனர் தள ஜெனரேட்டர்கள் ஒத்த நிலையான, ஆனால் இது எளிமையான ஒரு உள்ளமைவு மற்றும் செயல்படுத்தல் உள்ளது.

ஒரு சாதாரண பயனர் இந்த மென்பொருளையும் பயன்படுத்தலாம் குறிப்புகளை எடுக்க உள்ளூர் தளத்தை உருவாக்கவும் தனக்காக அல்லது வேறு எதற்கும்.

MkDocs ஐ நிறுவவும்

உள்ளூரில் நிறுவவும்

MkDocs ஐ நிறுவுவது மிகவும் எளிதானது என்று பார்ப்போம். நம்மால் முடியும் குழாய் பயன்படுத்தி அதை நிறுவவும். நீங்கள் ஒரு முனையத்தை (Ctrl + Alt + T) திறந்து அதில் எழுத வேண்டும்:

pip install mkdocs

நிறுவிய பின், உங்கள் பணி அடைவில், பின்வரும் கட்டளையை இயக்கவும் ஒரு தளத்தை துவக்கவும்:

mkdocs new mkdocspro

பின்னர் அதை சேவை செய்யத் தொடங்குங்கள் ஓடு:

cd mkdocspro

mkdocs serve

நீங்கள் முடியும் லோக்கல் ஹோஸ்டுக்குச் செல்லுங்கள்: 8000 (அல்லது போர்ட் 8000 உடன் உங்கள் ஐபி முகவரி / ஹோஸ்ட்பெயர்) MkDocs எவ்வாறு செயல்படுகிறது என்பதைக் காண.

உங்கள் nginx சேவையகத்தில் நிறுவவும்

இது நிலையான தள ஜெனரேட்டர் என்பதால், PHP அல்லது பைதான் போன்ற பின்தளத்தில் இயந்திரம் தேவையில்லை. உங்கள் வலை சேவையகத்தில் (nginx, apache2) MkDocs திட்டத்தை ஒரு நிமிடத்தில் செயல்படுத்த முடியும். உதாரணமாக, இங்கே nginx மெய்நிகர் ஹோஸ்ட் உள்ளமைவு:

server {
        server_name ejemplo.com;

        root /var/www/mkdocspro/sitio;
        index index.html;

        location / {
                try_files $uri $uri/ =404;
        }
}

மாற்றுகிறது example.com உங்கள் சேவையகத்தில் உங்களிடம் உள்ள டொமைனுடன். நீங்கள் மாற்ற வேண்டும் / var / www / mkdocspro / site உங்கள் சேவையகத்தில் தளத்தின் துணைக் கோப்புறையின் பாதை மூலம். அப்போதுதான் நம்மிடம் இருக்கிறது மறுதொடக்கம் nginx பின்வரும் கட்டளையுடன்:

sudo service nginx restart

இப்போது நீங்கள் example.com க்குச் சென்று அது செயல்படுவதைக் காணலாம்.

Mkdocs இல் மற்றொரு கருப்பொருளை நிறுவவும்

இயல்புநிலை Mkdocs தீம் குறிப்பாக நல்லதல்ல. ஆனால் நீங்கள் ஒரு நிமிடத்தில் இன்னொன்றை நிறுவலாம். மற்றொரு கருப்பொருளை நிறுவுவதற்கான எடுத்துக்காட்டு, பின்வருவனவாக இருக்கும். அதனுடன் நாம் போகிறோம் பொருள் தீம் நிறுவ:

pip install mkdocs-material

நிறுவிய பின், கருப்பொருளை செயல்படுத்த, நீங்கள் செய்ய வேண்டும் உங்கள் mkdocs.yml கோப்பைத் திருத்தி இதைப் போலவே செய்யுங்கள். சில விருப்பங்களைச் சேர்க்கலாம்:

site_name: Proyecto MkDocs
site_url: 'http://ejemplo.com'
repo_url: 'https://github.com/nombreusuario/proyectourlongithub'
edit_uri: edit/master
site_description: 'Aquí una descripción corta.'
google_analytics: ['UA-xxxxxxxxx-x', 'ejemplo.com']
extra:
  favicon: 'https://ejemplo/favicon.png'
  social:
    - type: 'github'
      link: 'https://github.com/xxxxxx'
    - type: 'facebook'
      link: 'https://facebook.com/xxxxxxx'
    - type: 'twitter'
      link: 'https://twitter.com/xxxxxxx'
  disqus: 'minombredisqus'
  theme: 'material'

விருப்பங்கள் மிகவும் தெளிவாக உள்ளன. ஆனால் இங்கே சில விளக்கங்கள் உள்ளன:

• repo_url: என்பது கிட் களஞ்சிய URL. உங்கள் MkDocs திட்டத்தில் நேரடியாக Git ஐ ஒருங்கிணைக்க நீங்கள் திட்டமிட்டால், பக்கங்களைத் திருத்த அல்லது திட்டத்தை முடுக்கிவிட மக்களை அனுமதிக்க இந்த விருப்பத்தைப் பயன்படுத்தலாம்.
• edit_uri: இந்த GitHub இல் பக்கங்களைத் திருத்துவதற்கான போஸ்ட்ஃபிக்ஸ். நீங்கள் GitLab அல்லது GitBucket ஐப் பயன்படுத்துகிறீர்கள் என்றால் அதை மாற்றலாம்.
• google_analytics: MkDocs க்கு கட்டுப்பாட்டு குழு இல்லை. எனவே, தெரிந்து கொள்ள உங்கள் வலைத்தளத்தைப் பார்வையிடும், நீங்கள் Google Analytics ஐப் பயன்படுத்த வேண்டும். வலைத்தளத்துடன் உங்கள் கணக்கை இணைக்க உங்கள் கண்காணிப்பு எண்ணைச் செருக இந்த விருப்பம் உங்களை அனுமதிக்கும்.
• பத்தல: உனக்கு வேண்டுமென்றால் Disqus கருத்துரைக்கும் அமைப்பை இயக்கவும் இணையதளத்தில், உங்கள் குறுகிய பெயரை இங்கே செருகலாம்.
• தீம்: நீங்கள் பயன்படுத்த விரும்பும் தீம் பெயர். பொருள் கருப்பொருளை நாங்கள் செய்ததைப் போல நீங்கள் இதை முன்பு நிறுவ வேண்டும். எடுத்துக்காட்டில் நாம் பயன்படுத்தும் பெயராக இது இருக்கும்.

புதிய கருப்பொருளின் மாற்றங்களைக் காண்க

கோப்பைச் சேமித்த பிறகு, mkdocs ஐ இயக்கவும் mkdocsproject கோப்புறையில். பொருள் கருப்பொருளின் இயல்புநிலை தோற்றத்தையும் உணர்வையும் உங்கள் வலைத்தளம் ஏற்றுக்கொள்ளும்:

முக்கியமான: ஒவ்வொரு மாற்றத்திற்கும் பிறகு mkdocs கட்டமைப்பை எப்போதும் இயக்குவதை உறுதிசெய்க நீங்கள் கோப்புகளில் செய்கிறீர்கள். இல்லையெனில் நீங்கள் எந்த மாற்றத்தையும் காண மாட்டீர்கள்.

பல உள்ளன பிற கருப்பொருள்கள் மற்றும் விருப்பங்கள் இந்த மென்பொருளை உள்ளமைக்க. நீங்கள் அவர்களை ஆலோசிக்க முடியும் உத்தியோகபூர்வ ஆவணங்கள் வழங்கியவர் MkDocs. இங்கே ஒரு பட்டியல் சாத்தியமான விருப்பங்கள் நாம் பயன்படுத்தலாம்.