Mkdocs, yenza amaxwebhu enkosi kule software yomthombo uvulekileyo

Kwinqaku elilandelayo siza kujonga kwiMkdocs. Ukuba uphuhlisa isoftware kwaye ufune iqonga lokwenza amaxwebhu Ngenye yeeprojekthi zakho. Okanye ukuba usebenza kwinkampani efuna ukwenza uxwebhu lwangaphakathi lwabasebenzi. Nokuba ungumsebenzisi ophambili ofuna ukugcina amanqaku athile. I-MkDocs sisixhobo ekufuneka usizamile.

Le software sisixhobo esimileyo sendawo ejolise ekwenzeni amaqonga amaxwebhu. Ilula kakhulu, intle ukujonga, kwaye kulula ukuseta kunye nokuhambisa. Ngaba ibhalwe kwi python ngokulula ifuna ukuba wenze iifayile zakho kwifomathi yeMarkdown. Emva koko, usebenzisa ifayile enye yoqwalaselo lwe-YAML, unokuvelisa iwebhusayithi emileyo ekusebenzela.

Okulandelayo siza kubona ukuba kulula kangakanani ukufumana amaxwebhu agcweleyo kwiwebhusayithi usebenzisa iiMkDocs. Zininzi ezinye abavelisi besiza static efanayo, kodwa oku inoqwalaselo kunye nokuphunyezwa kweyona ilula.

Umsebenzisi oqhelekileyo unokusebenzisa le software ukwenza yenza iqonga lendawo ukuthatha amanqaku isiqu sakhe okanye enye into efana nayo.

Faka iiMkDocs

Faka indawo ekuyo

Masibone ukuba ukufaka i-MkDocs kulula kakhulu. Siza kukwazi yifake usebenzisa umbhobho. Kuya kufuneka uvule i-terminal (Ctrl + Alt + T) kwaye ubhale kuyo:

pip install mkdocs

Emva kofakelo, kulawulo lwakho olusebenzayo, sebenzisa lo mthetho ulandelayo ukuya qala indawo:

mkdocs new mkdocspro

Kwaye emva koko uye ku qalisa ukuyiphaka baleka:

cd mkdocspro

mkdocs serve

Emva koko unako yiya kwindawo yasekhaya: 8000 (okanye idilesi ye-IP / igama lenginginya ngezibuko 8000) ukubona ukuba isebenza njani iMkDocs.

Faka kwiseva yakho ye-nginx

Kuba le yindawo emileyo yokuvelisa indawo, akukho injini yokubuyela umva efunekayo njenge-PHP okanye iPython. Uyakwazi ukumilisela iprojekthi ye-MkDocs kwiseva yakho yewebhu (nginx, apache2) ngomzuzu. Umzekelo, nantsi Uqwalaselo lwe-host ye-nginx:

server {
        server_name ejemplo.com;

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

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

Buyisela Umzekelo.com ngethambeka onalo kwiseva yakho. Kuya kufuneka utshintshe / var / www / mkdocspro / indawo ngendlela yolawulo lwesiza esikwiserver yakho. Ke sinayo kuphela qala kwakhona i-nginx ngalo myalelo ulandelayo:

sudo service nginx restart

Ngoku ungaya kwi example.com kwaye uyibone isebenza.

Faka omnye umxholo kwiiMkdocs

Umxholo osisiseko we-Mkdocs awulunganga ngakumbi. Kodwa ungafaka enye ngomzuzu. Umzekelo wofakelo lomnye umxholo, uya kuba zezi zilandelayo. Esiza kuthi ngayo faka umxholo wemathiriyeli:

pip install mkdocs-material

Emva kofakelo, ukwenza umxholo usebenze, kuya kufuneka hlela ifayile yakho ye mkdocs.yml kwaye uyenze ifane nale. Olunye ukhetho lunokongezwa:

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'

Izinketho zicacile. Kodwa nantsi inkcazo:

• repo_url: Ingaba i Git yokugcina i-URL. Ukuba ucwangcisa ukudibanisa iGit ngqo kwiprojekthi yakho ye-MkDocs, ungasebenzisa olu khetho ukuvumela abantu ukuba bahlele amaphepha okanye ifolokhwe yeprojekthi.
• hlela_uri: Le yeyona nto Iposi yokuhlelwa kwamaphepha kwiGitHub. Ungayitshintsha ukuba usebenzisa iGitLab okanye iGitBucket.
• google_analyticsAkukho lolawulo lolawulo lweMkDocs. Ke ngoko, ukwazi otyelela iwebhusayithi yakho, kuya kufuneka usebenzise uGoogle Analytics. Olu khetho luya kukuvumela ukuba ufake inombolo yakho yokulandelela ukudibanisa iakhawunti yakho kunye newebhusayithi.
• ngafuni: Ukuba uyafuna Nika amandla inkqubo yokunika ingxelo kwiwebhusayithi, ungafaka igama lakho elifutshane apha.
• umxholo: I igama lomxholo ofuna ukuwusebenzisa. Kuya kufuneka uyifakele ngaphambili, njengoko besenzile nje ngomxholo wezinto eziphathekayo. Eli iya kuba ligama esiza kulisebenzisa kulo mzekelo.

Jonga utshintsho lomxholo omtsha

Emva kokugcina ifayile, sebenzisa mkdocs ukwakha ngaphakathi kwifolda ye-mkdocsproject. Iwebhusayithi yakho iya kwamkela ukujongeka okungagungqiyo kunye nokuziva kumxholo weMathiriyeli:

Kubalulekile: qiniseka ukuba uhlala uqhuba i-mkdocs ukwakha emva kohlengahlengiso ngalunye oyenzayo kwiifayile. Ngaphandle koko awuyi kubona naluphi na utshintsho.

Zininzi eminye imixholo kunye nokukhetha ukuqwalasela le software. Ungathetha nabo kwi amaxwebhu asemthethweni ngeMkDocs. Nalu uluhlu lwe ukhetho olunokwenzeka esinokuzisebenzisa.