Meitsje in requirements.txtbestân mei de folgjende ynhâld
Posted: Mon Dec 23, 2024 4:33 am
theme: Wy brûke hjir it Materiaal-tema foar MkDocs, dat in modern en skjin ûntwerp foar jo dokumintaasje leveret.
nav: Dit stelt de navigaasjestruktuer yn foar jo side. Yn dit gefal hawwe wy twa siden: Homeen About, dy't wy yn 'e folgjende stap sille definiearje.
Stap 3: Meitsje jo dokumintaasjesiden
Litte wy no de eigentlike ynhâld foar jo side oanmeitsje. Meitsje binnen jo telemarketinggegevens projektmap in map mei de namme docs. Dizze map sil jo Markdown-bestannen befetsje dy't MkDocs sil brûke om de side te generearjen.
Meitsje yn 'e docs/map twa Markdown-bestannen:
This is the home page for your documentation.
about.mdfoar de side "Oer":
This page gives more information about the project.
Dizze Markdown-bestannen wurde automatysk werjûn as HTML troch MkDocs, en de navigaasjestruktuer dy't jo yn it mkdocs.ymlbestân ynsteld hawwe sil nei dizze siden keppelje.
Stap 4: Konfigurearje Netlify foar ynset
Om jo MkDocs-side op Netlify yn te setten, moatte jo de bouynstellingen konfigurearje.
Meitsje yn 'e root fan jo projekt in netlify.tomlbestân mei de folgjende ynhâld:
command: Dit fertelt Netlify om it mkdocs buildkommando út te fieren, dat de statyske bestannen genereart foar jo dokumintaasjeside.
publishsite/: MkDocs jout standert de statyske side yn 'e map út , dus spesifisearje wy dat as de map om te publisearjen.
environment: Hjir hawwe wy de Python-ferzje ynsteld om 3.13te profitearjen fan de lêste ferzje.
Stap 5: Ynsette nei Netlify
Jo binne no klear om jo MkDocs-side yn te setten! Druk jo projekt nei in Git-repository (bgl. GitHub, GitLab, of Bitbucket), en ferbine it mei Netlify.
nav: Dit stelt de navigaasjestruktuer yn foar jo side. Yn dit gefal hawwe wy twa siden: Homeen About, dy't wy yn 'e folgjende stap sille definiearje.
Stap 3: Meitsje jo dokumintaasjesiden
Litte wy no de eigentlike ynhâld foar jo side oanmeitsje. Meitsje binnen jo telemarketinggegevens projektmap in map mei de namme docs. Dizze map sil jo Markdown-bestannen befetsje dy't MkDocs sil brûke om de side te generearjen.
Meitsje yn 'e docs/map twa Markdown-bestannen:
This is the home page for your documentation.
about.mdfoar de side "Oer":
This page gives more information about the project.
Dizze Markdown-bestannen wurde automatysk werjûn as HTML troch MkDocs, en de navigaasjestruktuer dy't jo yn it mkdocs.ymlbestân ynsteld hawwe sil nei dizze siden keppelje.
Stap 4: Konfigurearje Netlify foar ynset
Om jo MkDocs-side op Netlify yn te setten, moatte jo de bouynstellingen konfigurearje.
Meitsje yn 'e root fan jo projekt in netlify.tomlbestân mei de folgjende ynhâld:
command: Dit fertelt Netlify om it mkdocs buildkommando út te fieren, dat de statyske bestannen genereart foar jo dokumintaasjeside.
publishsite/: MkDocs jout standert de statyske side yn 'e map út , dus spesifisearje wy dat as de map om te publisearjen.
environment: Hjir hawwe wy de Python-ferzje ynsteld om 3.13te profitearjen fan de lêste ferzje.
Stap 5: Ynsette nei Netlify
Jo binne no klear om jo MkDocs-side yn te setten! Druk jo projekt nei in Git-repository (bgl. GitHub, GitLab, of Bitbucket), en ferbine it mei Netlify.