mkdocs.yml

site_name: PnP/PnPjs

docs_dir: 'docs'

nav:
  - Home: 'index.md'
  - 'Getting Started': 'getting-started.md'
  - 'Transition Guide': 'transition-guide.md'
  - General:
    - 'Getting Started': 'getting-started.md'
    - 'Transition Guide': 'transition-guide.md'
    - 'Npm Scripts': 'npm-scripts.md'
    - 'SPFx On-Premises': 'SPFx-on-premises.md'
    - 'Working in Nodejs': 'nodejs-support.md'
  - 'Library Concepts':
    - 'Configuration': 'concepts/configuration.md'
    - 'Selective Imports': 'concepts/selective-imports.md'
    - 'Custom Bundle': 'concepts/custom-bundle.md'
    - 'IE11 Mode': 'concepts/ie11-mode.md'
    - 'Invokables': 'concepts/invokable.md'
    - 'Polyfills': 'concepts/polyfill.md'
    - 'Settings': 'concepts/settings.md'
    - 'Error Handling': 'concepts/error-handling.md'
    - 'Authentication':
      - 'Getting Started': 'authentication/index.md'
      - 'SPFx Auth': 'authentication/client-spfx.md'
      - 'MSAL Client': 'authentication/msaljsclient.md'
      - 'ADAL Client': 'authentication/adaljsclient.md'
      - 'SPA Auth': 'authentication/client-spa.md'
      - 'NodeJS Auth': 'authentication/server-nodejs.md'
      - 'SP App Reg': 'authentication/sp-app-registration.md'
  - Packages:
    - Packages: 'packages.md'
    - common:
      - common: 'common/index.md'
      - collections: 'common/collections.md'
      - 'Custom HttpClientImpl': 'common/custom-httpclientimpl.md'
      - libconfig: 'common/libconfig.md'
      - netutil: 'common/netutil.md'
      - storage: 'common/storage.md'
      - util: 'common/util.md'
    - config-store:
      - config-store: 'config-store/index.md'
      - configuration: 'config-store/configuration.md'
      - providers: 'config-store/providers.md'
    - graph: 
      - graph: 'graph/index.md'
      - groups: 'graph/groups.md'
      - insights: 'graph/insights.md'
      - contacts: 'graph/contacts.md'
      - calendars: 'graph/calendars.md'
      - 'directory objects': 'graph/directoryobjects.md'
      - invitations: 'graph/invitations.md'
      - onedrive: 'graph/onedrive.md'
      - planner: 'graph/planner.md'
      - subscriptions: 'graph/subscriptions.md'
      - teams: 'graph/teams.md'
      - users: 'graph/users.md'
    - logging: 'logging/index.md'
    - nodejs:
      - nodejs: 'nodejs/index.md'
      - SPFetchClient: 'nodejs/sp-fetch-client.md'     
      - AdalFetchClient: 'nodejs/adal-fetch-client.md'
      - BearerTokenFetchClient: 'nodejs/bearer-token-fetch-client.md'       
      - ProviderHostedRequestContext: 'nodejs/provider-hosted-app.md'
      - 'sp Extensions': 'nodejs\sp-extensions.md'      
    - odata:
      - odata: 'odata/index.md'
      - caching: 'odata/caching.md'
      - core: 'odata/core.md'
      - 'OData Batching': 'odata/odata-batch.md'
      - 'Extending an OData library': 'odata/extensions.md'
      - 'Debugging Proxy Objects': 'odata/debug.md'
      - Parsers: 'odata/parsers.md'
      - Pipeline: 'odata/pipeline.md'
      - Queryable: 'odata/queryable.md'
    - pnpjs:
      - pnpjs: 'pnpjs/index.md'
    - sp:
      - sp: 'sp/index.md'
      - 'Alias Parameters': 'sp/alias-parameters.md'
      - 'ALM api': 'sp/alm.md'
      - Attachments: 'sp/attachments.md'
      - 'Client-side Pages': 'sp/clientside-pages.md'
      - 'Column Defaults': 'sp/column-defaults.md'
      - 'Comments and Likes': 'sp/comments-likes.md'
      - 'Content Types': 'sp/content-types.md'
      - 'Entity Merging': 'sp/entity-merging.md'
      - Features: 'sp/features.md'
      - Fields: 'sp/fields.md'
      - Files: 'sp/files.md'
      - Folders: 'sp/folders.md'
      - Forms: 'sp/forms.md'
      - Hubsites: 'sp/hubsites.md'
      - 'List Items': 'sp/items.md'
      - Lists: 'sp/lists.md'      
      - 'Navigation': 'sp/navigation.md'
      - Permissions: 'sp/permissions.md'
      - Profiles: 'sp/profiles.md'
      - 'Regional Settings': 'sp/regional-settings.md'
      - 'Related Items': 'sp/related-items.md'
      - Search: 'sp/search.md'
      - Security: 'sp/security.md'
      - Sharing: 'sp/sharing.md'
      - 'Site Designs': 'sp/site-designs.md'
      - 'Site Groups': 'sp/site-groups.md'
      - 'Site Scripts': 'sp/site-scripts.md'
      - 'Site Users': 'sp/site-users.md'
      - Sites: 'sp/sites.md'
      - Social: 'sp/social.md'
      - 'SP.Utilities.Utility': 'sp/sp-utilities-utility.md'
      - Subscriptions: 'sp/subscriptions.md'
      - Taxonomy: 'sp/taxonomy.md'
      - 'Tenant Properties': 'sp/tenant-properties.md'
      - 'User custom actions': 'sp/user-custom-actions.md'      
      - Views: 'sp/views.md'
      - Webs: 'sp/webs.md'
      - 'Custom Request Client': 'sp/custom-irequestclient.md'
    - sp-addinhelpers:
      - sp-addinhelpers: 'sp-addinhelpers/index.md'
      - SPRequestExecutorClient:  'sp-addinhelpers/sp-request-executor-client.md'
      - SPRestAddIn: 'sp-addinhelpers/sp-rest-addin.md'
  - Contributing:
    - 'Contributing': 'contributing/index.md'
    - 'Setup Dev Maching': 'contributing/setup-dev-machine.md'
    - 'Local Debug Configuration': 'contributing/local-debug-configuration.md'
    - 'Debugging': 'contributing/debugging.md'
    - 'Extending the library': 'contributing/extending-the-library.md'
    - 'Writing Tests': 'contributing/debug-tests.md'
    - 'Update Documentation': 'contributing/documentation.md'
    - 'Submit a Pull Request': 'contributing/pull-requests.md'
  - Version 1 Docs:
    - Home: 'v1/index.html'

theme:
  name: 'material'
  custom_dir: 'docs/_theme'
  palette:
    primary: 'blue'
  logo: 'img/Logo.png'
  feature:
    tabs: true

extra_css:
  - 'css/extra.css'

extra_javascript:
    - https://unpkg.com/mermaid@8.5.2/dist/mermaid.min.js

markdown_extensions:
  - admonition
  - pymdownx.superfences
      # custom_fences:
      #   - name: mermaid
      #     class: mermaid
      #     format: !!python/name:pymdownx.superfences.fence_div_format
  - toc:
      permalink: true

plugins:
  - search
  - markdownextradata
  # - mermaid2:
  #     arguments:
  #       securityLevel: 'loose'
  #       theme: 'default'
  - redirects:
      redirect_maps:
          'adaljsclient/index.md': 'authentication/index.md'
          'adaljsclient/adalclient.md': 'authentication/adaljsclient.md'
          'getting-started-dev.md': 'contributing/index.md'
          'debugging.md': 'contributing/debugging.md'
          'debug-tests.md': 'contributing/debug-tests.md'
          'documentation.md': 'contributing/documentation.md'

extra:
  social:
    - type: 'twitter'
      link: 'https://twitter.com/officedevpnp'
    - type: 'youtube'
      link: 'http://aka.ms/sppnp-videos'
    - type: 'link'
      link: 'https://aka.ms/sppnp'

repo_url: http://github.com/pnp/pnpjs

edit_uri: tree/version-2/docs

site_url: https://pnp.github.io/pnpjs/