mkdocs.yml

site_name: nyaf Documentation
repo_url: https://github.com/joergkrause/nyaf/
site_description: The leading Web Component Framework's Documentation
docs_dir: docs
site_dir: dist/manual
nav:
  - Home: index.md
  - Introduction: md/intro.md
  - Learn: md/learn.md
  - Project Configuration (TS): md/ts.md
  - Project Configuration (JS): md/babel.md
  - Configuration Files: md/config.md
  - Core Library:
    - Overview: md/docs/lib/overview.md
    - Template Language: md/docs/lib/template.md
    - JSX / TSX: md/docs/lib/jsx.md
    - Select Elements: md/docs/lib/select.md
    - Smart Components: md/docs/lib/smart.md
    - Life Cycle: md/docs/lib/lifecycle.md
    - Attributes: md/docs/lib/attributes.md
    - Directives: md/docs/lib/directives.md
    - Events: md/docs/lib/events.md
    - Router: md/docs/lib/router.md
    - Shadow DOM: md/docs/lib/shadowdom.md
    - Services: md/docs/lib/services.md
  - Forms Extension:
    - Overview: md/docs/forms/overview.md
    - View Models: md/docs/forms/vm.md
    - Data Binding: md/docs/forms/nbind.md
    - Validation: md/docs/forms/validation.md
    - Custom Binders: md/docs/forms/custombinders.md
    - Setup: md/docs/forms/setup.md
  - Flux Store:
    - Overview: md/docs/store/overview.md
    - The Store Types: md/docs/store/example.md
    - Global and Local Stores: md/docs/store/globloc.md
    - Disposing Subscriptions: md/docs/store/dispose.md
    - Effects Mapping: md/docs/store/effects.md
    - Automatic Updates: md/docs/store/updates.md
    - Setup: md/docs/store/setup.md
  - Comparision of @nyaf with...:
    - ...Angular: md/docs/comparision/angular.md
    - ...Polymer: md/docs/comparision/polymer.md
    - ...Preact: md/docs/comparision/preact.md
    - ...React: md/docs/comparision/react.md
    - ...Stencil: md/docs/comparision/stencil.md
    - ...Svelte: md/docs/comparision/svelte.md
    - ...Vue: md/docs/comparision/vue.md
  - Internals:
    - About: md/docs/internals/about.md
    - Licence: md/docs/internals/lic.md
    - How it's being made: md/docs/internals/start.md
theme:
  custom_dir: docs/_templates/
  name: readthedocs
  nav_style: light
  prev_next_buttons_location: both
  highlightjs: true
  shortcuts:
      help: 191    # ?
      next: 78     # n
      previous: 80 # p
      search: 83   # s
markdown_extensions:
  - toc:
      permalink: "#"