config.json.js 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. /**
  2. * This is a configuration file, feel free to edit options below.
  3. * By default most recommended options has been set for your documentation
  4. * (default options depends on the documentation size and template preferences).
  5. *
  6. * To apply changes made in config.json.js you have a few options:
  7. * - customize template, set configuration and export customized template,
  8. * - or change the "v" query param in the exported index.html file:
  9. * <script src="config.json.js?v=<NEW_RANDOM_STRING>"></script>
  10. * - or open index.html and press ctrl + f5 to reload configuration (not recommended).
  11. */
  12. window.userConfig = {
  13. /**
  14. * After refreshing the page or opening the same documentation
  15. * after a while, menu tree restore to the latest state.
  16. *
  17. * This option is automatically disabled for huge documentations
  18. * because it's a time consumed operation for large data files.
  19. */
  20. rememberMenuTreeState: true,
  21. /**
  22. * If option is enabled then scroll of the menu tree will be
  23. * adjusted after every link click in such way that clicked
  24. * element will be visible in the menu tree.
  25. */
  26. scrollMenuOnClick: true,
  27. /**
  28. * The height of a logo in the sidebar.
  29. *
  30. * Height must be set to avoid layout jumping after loading the image.
  31. * This also gives a possibility to scale high resolution image.
  32. */
  33. logoHeight: 30,
  34. };