Code Monkey home page Code Monkey logo

malarkitektur-digital-hjemmeoppfolging's Introduction

Testdokumentasjon Målarkitektur-digital-hjemmeoppfølging

Testprosjekt for å se hvordan arkitekturdokumentasjon enklest mulig kan publiseres og vedlikeholdes på Github.

Tema

Mangler

  • Mangler nav bar footer?
  • Mangler fargerike labels

Brukte tema (historikk)

Forutsetninger (just-the-docs)

  • index.md må ligge i rotkatalog på prosjektet?
  • markdown filene bør ha just-the-docs metadata
---
layout: default
title: Innledning
nav_order: 1
---

Testing med Read-the-docs, mkdocs og just the docs (ghpages)

  • Hvordan kjører vi versjoner (mike)

  • Prøvde dette scriptet for å bruke just the docs temaet med push til gh-branchen, men det feilet når Jekyll skulle startes

Oppdatere Just-the-docs versjon samtidig som mkdocs

  • Just-the-docs kan bare eksistere i hovedkatalogen på gh-pages branchen på github.io, ellers brytes alle koblinger til bilder og andre sider (kanskje det eksisterer en innstilling?)
  • Mkdocs versjonen kan godt ligge under katalog (for eksempel "currentbuild") uten at lenker brytes
  • Scriptet fungerer for produksjon av just-the-docs og deploy til gh-pages branch (root) Deploy Jekyll with JTD to gh-pages(root)
    • Scriptet sletter gh-pages branchen i sin helhet før ny deploy
    • Det er peaciris action som sletter også currentbranch katalogen
      • Løsning, enten bruke opsjon for å beholde filer eller legge byggene i underkataloger, peaciris sletter bare gjeldende deploykatalog i destination_dir (men hvis dette er rotkatalogen (".") slettes hele gh-pages branchen)

Konfigurere Just-the-docs for eksistens i underkatalog (e.g. currentbuild)

Konfigurere baseurl og hostname for hvor dokumentasjonen skal ligge i _config.yml

baseurl: "/Malarkitektur-digital-hjemmeoppfolging/JTD-currentbuild" # the subpath of your site, e.g. /blog
url: "https://thomiz.github.io" # the base hostname & protocol for your site, e.g. http://example.com

Konfigurere deployscriptet tilsvarende (hvor peaciris legger produsert dokumentasjon).

- name: Deploy
    uses: peaceiris/actions-gh-pages@v3
    with:
      github_token: ${{ secrets.GITHUB_TOKEN }}
      publish_dir: ./_site
      destination_dir: ./JTD-currentbuild # Må stemme med baseurl: parameter i _config

malarkitektur-digital-hjemmeoppfolging's People

Contributors

thomiz avatar

Stargazers

 avatar

Watchers

 avatar  avatar

malarkitektur-digital-hjemmeoppfolging's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.