kfr

Fast, modern C++ DSP framework, FFT, Sample Rate Conversion, FIR/IIR/Biquad Filters (SSE, AVX, AVX-512, ARM NEON)
Log | Files | Refs | README

mkdocs.yml (3331B)


      1 site_name: KFR
      2 theme:
      3   name: "material"
      4   features:
      5     - navigation.tabs
      6     - navigation.top
      7     - content.code.copy
      8   palette:
      9     # Palette toggle for light mode
     10     - scheme: default
     11       toggle:
     12         icon: material/brightness-7
     13         name: Switch to dark mode
     14 
     15     # Palette toggle for dark mode
     16     - scheme: slate
     17       toggle:
     18         icon: material/brightness-4
     19         name: Switch to light mode
     20 
     21 extra:
     22   search:
     23     language: en
     24 
     25   social:
     26     - icon: fontawesome/brands/github-alt
     27       link: "https://github.com/kfrlib"
     28     - icon: fontawesome/brands/twitter
     29       link: "https://twitter.com/kfrlib"
     30 
     31 copyright: "Copyright © 2016 - 2024 KFR"
     32 
     33 plugins:
     34   - search
     35   - privacy
     36 
     37 markdown_extensions:
     38   - admonition
     39   - footnotes
     40   - meta
     41   - toc:
     42       permalink: true
     43   - pymdownx.arithmatex:
     44       generic: true
     45   - pymdownx.inlinehilite
     46   - pymdownx.superfences
     47   - pymdownx.highlight
     48   - pymdownx.details
     49   - pymdownx.magiclink
     50   - pymdownx.tabbed:
     51       alternate_style: true
     52   - pymdownx.emoji:
     53       emoji_index: !!python/name:material.extensions.emoji.twemoji
     54       emoji_generator: !!python/name:material.extensions.emoji.to_svg
     55 
     56 extra_javascript:
     57   - js/math.js
     58   - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0/katex.min.js
     59 
     60 extra_css:
     61   - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0/katex.min.css
     62   - css/fix.css
     63 
     64 repo_url: https://github.com/kfrlib/kfr
     65 repo_name: KFR
     66 edit_uri: edit/main/docs/
     67 
     68 nav:
     69   - KFR:
     70       - index.md
     71       - whatsnew6.md
     72       - installation.md
     73       - basics.md
     74       - expressions.md
     75       - capi.md
     76       - upgrade6.md
     77       - benchmarking.md
     78   - DSP:
     79       - fir.md
     80       - bq.md
     81       - src.md
     82       - conv_reverb.md
     83       - ebur128.md
     84       - conversion.md
     85       - normalize.md
     86       - convert_stereo.md
     87       - fir_gallery.md
     88       - iir_gallery.md
     89       - bq_gallery.md
     90       - src_gallery.md
     91       - window_gallery.md
     92       - convolution.md
     93   - DFT:
     94       - dft.md
     95       - dft2.md
     96       - dft_format.md
     97   - I/O:
     98       - read_audio.md
     99       - file_support.md
    100       - plot.md
    101   - Reference:
    102       - auto/refindex.md
    103       - auto/capi.md
    104       - Math:
    105           - auto/complex.md
    106           - auto/constants.md
    107           - auto/logical.md
    108           - auto/basic_math.md
    109           - auto/exponential.md
    110           - auto/round.md
    111           - auto/saturation.md
    112           - auto/trigonometric.md
    113           - auto/hyperbolic.md
    114           - auto/horizontal.md
    115           - auto/other_math.md
    116       - Base:
    117           - auto/base.md
    118           - auto/types.md
    119           - auto/univector.md
    120           - auto/tensor.md
    121           - auto/expressions.md
    122           - auto/generators.md
    123           - auto/reducing.md
    124           - auto/random.md
    125           - auto/memory.md
    126           - auto/conversion.md
    127           - auto/sort.md
    128           - auto/utility.md
    129           - auto/array.md
    130       - DSP:
    131           - auto/filter.md
    132           - auto/biquad.md
    133           - auto/fir.md
    134           - auto/window.md
    135           - auto/dsp.md
    136           - auto/dsp_extra.md
    137       - DFT:
    138           - auto/convolution.md
    139           - auto/dft.md
    140       - IO:
    141           - auto/binary_io.md
    142           - auto/audio_io.md
    143           - auto/plotting.md
    144           - auto/string_io.md
    145       - Other functions: auto/default.md
    146       - auto/cpuid.md
    147       - auto/cometa.md
    148 
    149   - kfr.dev: https://kfr.dev