Mkdocs, ಈ ಓಪನ್ ಸೋರ್ಸ್ ಸಾಫ್ಟ್‌ವೇರ್‌ಗೆ ಧನ್ಯವಾದಗಳು ದಸ್ತಾವೇಜನ್ನು ರಚಿಸಿ

mkdocs ಬಗ್ಗೆ

ಮುಂದಿನ ಲೇಖನದಲ್ಲಿ ನಾವು ಎಂಕೆಡಾಕ್ಸ್ ಅನ್ನು ನೋಡೋಣ. ನೀವು ಸಾಫ್ಟ್‌ವೇರ್ ಅನ್ನು ಅಭಿವೃದ್ಧಿಪಡಿಸಿದರೆ ಮತ್ತು ಹುಡುಕುವುದು ದಸ್ತಾವೇಜನ್ನು ರಚಿಸಲು ಒಂದು ವೇದಿಕೆ ನಿಮ್ಮ ಯೋಜನೆಗಳಲ್ಲಿ ಒಂದಕ್ಕಾಗಿ. ಅಥವಾ ನೀವು ಕಂಪನಿಯಲ್ಲಿ ಕೆಲಸ ಮಾಡುತ್ತಿದ್ದರೆ ಅದು ಸಿಬ್ಬಂದಿಗೆ ಆಂತರಿಕ ದಾಖಲಾತಿಗಳನ್ನು ರಚಿಸಬೇಕಾಗುತ್ತದೆ. ನೀವು ಕೆಲವು ಟಿಪ್ಪಣಿಗಳನ್ನು ಉಳಿಸಲು ಬಯಸುವ ಸುಧಾರಿತ ಬಳಕೆದಾರರಾಗಿದ್ದರೂ ಸಹ. MkDocs ನೀವು ಪ್ರಯತ್ನಿಸಬೇಕಾದ ಸಾಧನವಾಗಿದೆ.

ಈ ಸಾಫ್ಟ್‌ವೇರ್ ದಸ್ತಾವೇಜನ್ನು ಪ್ಲಾಟ್‌ಫಾರ್ಮ್‌ಗಳನ್ನು ರಚಿಸುವ ಗುರಿಯನ್ನು ಹೊಂದಿರುವ ಸ್ಥಿರ ಸೈಟ್ ಜನರೇಟರ್ ಆಗಿದೆ. ಇದು ತುಂಬಾ ಸರಳವಾಗಿದೆ, ನೋಡಲು ಸುಂದರವಾಗಿದೆ ಮತ್ತು ಸೆಟಪ್ ಮಾಡಲು ಮತ್ತು ನಿಯೋಜಿಸಲು ಸುಲಭವಾಗಿದೆ. ಇದೆ ಪೈಥಾನ್‌ನಲ್ಲಿ ಬರೆಯಲಾಗಿದೆ ಮತ್ತು ಸರಳವಾಗಿ ನಿಮ್ಮ ಫೈಲ್‌ಗಳನ್ನು ಮಾರ್ಕ್‌ಡೌನ್ ಸ್ವರೂಪದಲ್ಲಿ ರಚಿಸುವ ಅಗತ್ಯವಿದೆ. ನಂತರ, ಒಂದೇ YAML ಕಾನ್ಫಿಗರೇಶನ್ ಫೈಲ್ ಬಳಸಿ, ನಿಮಗಾಗಿ ಕೆಲಸ ಮಾಡುವ ಸ್ಥಿರ ವೆಬ್‌ಸೈಟ್ ಅನ್ನು ನೀವು ರಚಿಸಬಹುದು.

ಮುಂದೆ ನಾವು MkDocs ಬಳಸಿ ಸಂಪೂರ್ಣ ದಸ್ತಾವೇಜನ್ನು ವೆಬ್‌ಸೈಟ್ ಪಡೆಯುವುದು ಎಷ್ಟು ಸುಲಭ ಎಂದು ನೋಡೋಣ. ಇನ್ನೂ ಅನೇಕರಿದ್ದಾರೆ ಸೈಟ್ ಜನರೇಟರ್ಗಳು ಇದೇ ರೀತಿಯ ಸ್ಥಿರ, ಆದರೆ ಇದು ಸರಳವಾದ ಸಂರಚನೆ ಮತ್ತು ಅನುಷ್ಠಾನವನ್ನು ಹೊಂದಿದೆ.

ಸಾಮಾನ್ಯ ಬಳಕೆದಾರರು ಈ ಸಾಫ್ಟ್‌ವೇರ್ ಅನ್ನು ಸಹ ಬಳಸಬಹುದು ಟಿಪ್ಪಣಿಗಳನ್ನು ತೆಗೆದುಕೊಳ್ಳಲು ಸ್ಥಳೀಯ ವೇದಿಕೆಯನ್ನು ರಚಿಸಿ ತನಗಾಗಿ ಅಥವಾ ಬೇರೆ ಯಾವುದಕ್ಕೂ.

MkDocs ಅನ್ನು ಸ್ಥಾಪಿಸಿ

ಸ್ಥಳೀಯವಾಗಿ ಸ್ಥಾಪಿಸಿ

MkDocs ಅನ್ನು ಸ್ಥಾಪಿಸುವುದು ತುಂಬಾ ಸುಲಭ ಎಂದು ನೋಡೋಣ. ನಾವು ಮಾಡಬಹುದು ಪಿಪ್ ಬಳಸಿ ಅದನ್ನು ಸ್ಥಾಪಿಸಿ. ನೀವು ಟರ್ಮಿನಲ್ ಅನ್ನು ತೆರೆಯಬೇಕು (Ctrl + Alt + T) ಮತ್ತು ಅದರಲ್ಲಿ ಬರೆಯಿರಿ:

PIP ಯೊಂದಿಗೆ mkdocs ಅನ್ನು ಸ್ಥಾಪಿಸಲಾಗುತ್ತಿದೆ

pip install mkdocs

ಅನುಸ್ಥಾಪನೆಯ ನಂತರ, ನಿಮ್ಮ ವರ್ಕಿಂಗ್ ಡೈರೆಕ್ಟರಿಯಲ್ಲಿ, ಈ ಕೆಳಗಿನ ಆಜ್ಞೆಯನ್ನು ಚಲಾಯಿಸಿ ಸೈಟ್ ಅನ್ನು ಪ್ರಾರಂಭಿಸಿ:

mkdocs ಉಡಾವಣಾ ಯೋಜನೆ

mkdocs new mkdocspro

ತದನಂತರ ಅದನ್ನು ಪೂರೈಸಲು ಪ್ರಾರಂಭಿಸಿ ಓಡು:

mkdocs ಅನ್ನು ಸೇವೆ ಮಾಡಿ

cd mkdocspro

mkdocs serve

ನಂತರ ನೀವು ಮಾಡಬಹುದು ಲೋಕಲ್ ಹೋಸ್ಟ್ಗೆ ಹೋಗಿ: 8000 (ಅಥವಾ ಪೋರ್ಟ್ 8000 ನೊಂದಿಗೆ ನಿಮ್ಮ ಐಪಿ ವಿಳಾಸ / ಹೋಸ್ಟ್ ಹೆಸರು) MkDocs ಹೇಗೆ ಕಾರ್ಯನಿರ್ವಹಿಸುತ್ತದೆ ಎಂಬುದನ್ನು ನೋಡಲು.

mkdovs ಅನ್ನು ಬ್ರೌಸರ್‌ನಿಂದ ವೀಕ್ಷಿಸಲಾಗಿದೆ

ನಿಮ್ಮ nginx ಸರ್ವರ್‌ನಲ್ಲಿ ಸ್ಥಾಪಿಸಿ

ಇದು ಸ್ಥಿರ ಸೈಟ್ ಜನರೇಟರ್ ಆಗಿರುವುದರಿಂದ, ಪಿಎಚ್ಪಿ ಅಥವಾ ಪೈಥಾನ್ ನಂತಹ ಯಾವುದೇ ಬ್ಯಾಕೆಂಡ್ ಎಂಜಿನ್ ಅಗತ್ಯವಿಲ್ಲ. ನಿಮ್ಮ ವೆಬ್ ಸರ್ವರ್‌ನಲ್ಲಿ (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: ಆಗಿದೆ Git ರೆಪೊಸಿಟರಿ URL. ನಿಮ್ಮ MkDocs ಯೋಜನೆಗೆ ನೇರವಾಗಿ Git ಅನ್ನು ಸಂಯೋಜಿಸಲು ನೀವು ಯೋಜಿಸುತ್ತಿದ್ದರೆ, ಪುಟಗಳನ್ನು ಸಂಪಾದಿಸಲು ಅಥವಾ ಯೋಜನೆಯನ್ನು ಫೋರ್ಕ್ ಮಾಡಲು ಜನರಿಗೆ ಅನುಮತಿಸಲು ನೀವು ಈ ಆಯ್ಕೆಯನ್ನು ಬಳಸಬಹುದು.
  • edit_uri: ಇದು GitHub ನಲ್ಲಿ ಪುಟಗಳನ್ನು ಸಂಪಾದಿಸಲು ಪೋಸ್ಟ್‌ಫಿಕ್ಸ್. ನೀವು ಗಿಟ್‌ಲ್ಯಾಬ್ ಅಥವಾ ಗಿಟ್‌ಬಕೆಟ್ ಬಳಸುತ್ತಿದ್ದರೆ ಅದನ್ನು ಬದಲಾಯಿಸಬಹುದು.
  • google_analytics: MkDocs ಗೆ ಯಾವುದೇ ನಿಯಂತ್ರಣ ಫಲಕವಿಲ್ಲ. ಆದ್ದರಿಂದ, ತಿಳಿಯಲು ನಿಮ್ಮ ವೆಬ್‌ಸೈಟ್‌ಗೆ ಯಾರು ಭೇಟಿ ನೀಡುತ್ತಾರೆ, ನೀವು Google Analytics ಅನ್ನು ಬಳಸಬೇಕು. ನಿಮ್ಮ ಖಾತೆಯನ್ನು ವೆಬ್‌ಸೈಟ್‌ನೊಂದಿಗೆ ಸಂಯೋಜಿಸಲು ನಿಮ್ಮ ಟ್ರ್ಯಾಕಿಂಗ್ ಸಂಖ್ಯೆಯನ್ನು ಸೇರಿಸಲು ಈ ಆಯ್ಕೆಯು ನಿಮಗೆ ಅನುಮತಿಸುತ್ತದೆ.
  • disqus: ನಿಮಗೆ ಬೇಕಾದರೆ ಡಿಸ್ಕುಸ್ ಕಾಮೆಂಟ್ ಮಾಡುವ ವ್ಯವಸ್ಥೆಯನ್ನು ಸಕ್ರಿಯಗೊಳಿಸಿ ವೆಬ್‌ಸೈಟ್‌ನಲ್ಲಿ, ನಿಮ್ಮ ಸಣ್ಣ ಹೆಸರನ್ನು ನೀವು ಇಲ್ಲಿ ಸೇರಿಸಬಹುದು.
  • ಥೀಮ್: ದಿ ನೀವು ಬಳಸಲು ಬಯಸುವ ಥೀಮ್‌ನ ಹೆಸರು. ವಸ್ತು ಥೀಮ್ನೊಂದಿಗೆ ನಾವು ಮಾಡಿದಂತೆ ನೀವು ಇದನ್ನು ಮೊದಲು ಸ್ಥಾಪಿಸಬೇಕಾಗುತ್ತದೆ. ಉದಾಹರಣೆಯಲ್ಲಿ ನಾವು ಬಳಸುವ ಹೆಸರು ಇದು.

ಹೊಸ ಥೀಮ್ನ ಬದಲಾವಣೆಗಳನ್ನು ನೋಡಿ

ಫೈಲ್ ಅನ್ನು ಉಳಿಸಿದ ನಂತರ, mkdocsproject ಫೋಲ್ಡರ್ ಒಳಗೆ mkdocs ನಿರ್ಮಿಸಿ. ನಿಮ್ಮ ವೆಬ್‌ಸೈಟ್ ಮೆಟೀರಿಯಲ್ ಥೀಮ್‌ನ ಡೀಫಾಲ್ಟ್ ನೋಟ ಮತ್ತು ಭಾವನೆಯನ್ನು ಅಳವಡಿಸಿಕೊಳ್ಳುತ್ತದೆ:

mkdocs ಕಸ್ಟಮ್ ಥೀಮ್

ಪ್ರಮುಖವಾದದ್ದು: ಪ್ರತಿ ಮಾರ್ಪಾಡಿನ ನಂತರ ಯಾವಾಗಲೂ mkdocs ಬಿಲ್ಡ್ ಅನ್ನು ಚಲಾಯಿಸಲು ಖಚಿತಪಡಿಸಿಕೊಳ್ಳಿ ನೀವು ಫೈಲ್‌ಗಳಲ್ಲಿ ಮಾಡುತ್ತೀರಿ. ಇಲ್ಲದಿದ್ದರೆ ನೀವು ಯಾವುದೇ ಬದಲಾವಣೆಯನ್ನು ನೋಡುವುದಿಲ್ಲ.

ಅನೇಕ ಇವೆ ಇತರ ವಿಷಯಗಳು ಮತ್ತು ಆಯ್ಕೆಗಳು ಈ ಸಾಫ್ಟ್‌ವೇರ್ ಅನ್ನು ಕಾನ್ಫಿಗರ್ ಮಾಡಲು. ನೀವು ಅವರನ್ನು ಸಂಪರ್ಕಿಸಬಹುದು ಅಧಿಕೃತ ದಸ್ತಾವೇಜನ್ನು MkDocs ಅವರಿಂದ. ಇಲ್ಲಿ ಒಂದು ಪಟ್ಟಿ ಇದೆ ಸಂಭವನೀಯ ಆಯ್ಕೆಗಳು ನಾವು ಬಳಸಬಹುದು.


2 ಕಾಮೆಂಟ್‌ಗಳು, ನಿಮ್ಮದನ್ನು ಬಿಡಿ

ನಿಮ್ಮ ಅಭಿಪ್ರಾಯವನ್ನು ಬಿಡಿ

ನಿಮ್ಮ ಈಮೇಲ್ ವಿಳಾಸ ಪ್ರಕಟವಾದ ಆಗುವುದಿಲ್ಲ. ಅಗತ್ಯವಿರುವ ಜಾಗ ಗುರುತಿಸಲಾಗಿದೆ *

*

*

  1. ಡೇಟಾಗೆ ಜವಾಬ್ದಾರಿ: ಮಿಗುಯೆಲ್ ಏಂಜೆಲ್ ಗಟಾನ್
  2. ಡೇಟಾದ ಉದ್ದೇಶ: ನಿಯಂತ್ರಣ SPAM, ಕಾಮೆಂಟ್ ನಿರ್ವಹಣೆ.
  3. ಕಾನೂನುಬದ್ಧತೆ: ನಿಮ್ಮ ಒಪ್ಪಿಗೆ
  4. ಡೇಟಾದ ಸಂವಹನ: ಕಾನೂನುಬದ್ಧ ಬಾಧ್ಯತೆಯನ್ನು ಹೊರತುಪಡಿಸಿ ಡೇಟಾವನ್ನು ಮೂರನೇ ವ್ಯಕ್ತಿಗಳಿಗೆ ಸಂವಹನ ಮಾಡಲಾಗುವುದಿಲ್ಲ.
  5. ಡೇಟಾ ಸಂಗ್ರಹಣೆ: ಆಕ್ಸೆಂಟಸ್ ನೆಟ್‌ವರ್ಕ್‌ಗಳು (ಇಯು) ಹೋಸ್ಟ್ ಮಾಡಿದ ಡೇಟಾಬೇಸ್
  6. ಹಕ್ಕುಗಳು: ಯಾವುದೇ ಸಮಯದಲ್ಲಿ ನೀವು ನಿಮ್ಮ ಮಾಹಿತಿಯನ್ನು ಮಿತಿಗೊಳಿಸಬಹುದು, ಮರುಪಡೆಯಬಹುದು ಮತ್ತು ಅಳಿಸಬಹುದು.

  1.   ಮೈಕೆಲ್ ಡಿಜೊ

    ಹಲೋ
    ಕ್ವಾಂಡ್ ಜೆ ಫೈಟ್ ಅನ್ ಎಂಕೆಡಾಕ್ಸ್ ಬಿಲ್ಡ್ ಪೌರ್ ಗಿನರೆರ್ ಸೋಮ ಸೈಟ್, ಡಾಸಿಯರ್ ಸೈಟ್ ಅನ್ನು ಇಂಡೆಕ್ಸ್ನೊಂದಿಗೆ ರಚಿಸಲಾಗಿದೆ. HTML ಮತ್ತು ಕ್ವಾಂಡ್ ಜೆ ವೈಸ್ ಸುರ್ ಮೊನ್ ಯುಆರ್ಎಲ್ ಜಾಯ್ http://mon_site/site.

    ಮತ್ತು ಎ ಟಿಲ್ ಮೊಯೆನ್ ಡೆ ರೆಕ್ರಿರೆ ಎನ್ http://mon_site/site en http://mon_site ?

    ಸಿಡಿಟಿ

    1.    ಡೇಮಿಯನ್ ಎ. ಡಿಜೊ

      ಸಲೂಟ್. Vous pouvez éventuellement trouver une solution à വോട്ട್ರೆ ಡಿಮ್ಯಾಂಡ್ ಡ್ಯಾನ್ಸ್ ಲಾ ದಸ್ತಾವೇಜನ್ನು ಡು ಪ್ರೊಜೆಟ್. ನಮಸ್ಕಾರಗಳು.