_pkgdown.yml

url: http://friendly.github.io/matlib

template:
  bootstrap: 5
  includes:
    in_header: |
      <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css" integrity="sha384-nB0miv6/jRmo5UMMR1wu3Gz6NLsoTkbqJghGIsx//Rlm+ZU03BU6SQNC66uf4l5+" crossorigin="anonymous">
      <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.js" integrity="sha384-7zkQWkzuo3B5mTepMUcHkMB5jZaolc2xDwL6VFqjFALcbeS9Ggm/Yr2r3Dy4lfFg" crossorigin="anonymous"></script>
      <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/contrib/auto-render.min.js" integrity="sha384-43gviWU0YVjaDtb/GhzOouOXtZMP/7XUzwPTstBeZFe/+rCMvRwr4yROQP43s0Xk" crossorigin="anonymous" onload="renderMathInElement(document.body);"></script>
# params:
#   bootswatch: cerulean
  bslib:
    base_font: {google: "Roboto"}
    heading_font: {google: "Roboto Slab"}
    code_font: {google: "JetBrains Mono"}

reference:
  - title: Package description
    contents:
      - matlib-package

  - title: Convenience functions
    desc:  Simple functions for matrix algebra oparations
    contents:
      - J
      - len
      - mpower
      - Proj
      - R
      - symMat
      - tr
      - vec
      - xprod

  - title: Determinants
    desc:  Functions for calculating determinants by cofactor expansion
    contents:
      - adjoint
      - cofactor
      - Det
      - minor
      - rowCofactors
      - rowMinors

  - title: Elementary row operations
    desc:  Functions for solving linear equations "manually" by the steps used in row echelon form and Gaussian elimination
    contents:
      - rowadd
      - rowmult
      - rowswap
      - buildTmat

  - title: Linear equations
    desc:  Functions to illustrate linear equations of the form $\mathbf{A x = b}$
    contents:
      - showEqn
      - plotEqn
      - plotEqn3d
      - Solve
      - printMatEqn
      - printMatrix
      
  - title: LaTeX matrices
    desc: Create and manipulate LaTeX repesentations of matrices and matrix equations
    contents:
      - matrix2latex
      - latexMatrix
      - latexMatrixOperations
      - Eqn

  - title: Gaussian elimination
    desc:  Functions for illustrating Gaussian elimination
    contents:
      - cholesky
      - echelon
      - gaussianElimination
      - Ginv
      - inv
      - Inverse
      - LU
      - MoorePenrose
      - QR
      - swp

  - title: Eigenvalues
    desc:  Functions to illustrate the algorithms for calculating eigenvalues and eigenvectors
    contents:
      - Eigen
      - powerMethod
      - showEig
      - SVD

  - title: Vector diagrams
    desc: Functions for drawing vector diagrams in 2D and 3D
    contents:
      - angle
      - arc
      - arrows3d
      - circle
      - circle3d
      - cone3d
      - corner
      - getYmult
      - pointOnLine
      - regvec3d
      - plot.regvec3d
      - vectors
      - vectors3d

  - title: Other
    desc: Other functions in the package, unclassified
    contents:
      - matrix2latex
      - GramSchmidt
      - gsorth
      - svdDemo
      - vandermode

  - title: Data
    desc: Some small data sets used in examples
    contents:
      - class
      - coffee
      - therapy
      - workers