doc_tree.go 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. package docsrc
  2. import (
  3. "github.com/qor5/docs/docsrc/content"
  4. advanced_functions "github.com/qor5/docs/docsrc/content/advanced-functions"
  5. "github.com/qor5/docs/docsrc/content/basics"
  6. digging_deeper "github.com/qor5/docs/docsrc/content/digging-deeper"
  7. getting_started "github.com/qor5/docs/docsrc/content/getting-started"
  8. "github.com/qor5/docs/docsrc/utils"
  9. "github.com/theplant/docgo"
  10. )
  11. var DocTree = []interface{}{
  12. content.Home,
  13. &docgo.DocsGroup{
  14. Title: "Getting Started",
  15. Docs: []*docgo.DocBuilder{
  16. getting_started.OneMinuteQuickStart,
  17. },
  18. },
  19. &docgo.DocsGroup{
  20. Title: "Building Admin",
  21. Docs: []*docgo.DocBuilder{
  22. // listing
  23. basics.Listing,
  24. basics.Filter,
  25. // editing
  26. basics.EditingCustomizations,
  27. // brand
  28. basics.Brand,
  29. // menu
  30. basics.ManageMenu,
  31. advanced_functions.DetailPageForComplexObject,
  32. // permission
  33. basics.Permissions,
  34. basics.Role,
  35. // other basics
  36. basics.NotificationCenter,
  37. basics.ShortCut,
  38. basics.ConfirmDialog,
  39. basics.Slug,
  40. basics.SEO,
  41. basics.Activity,
  42. basics.Worker,
  43. },
  44. },
  45. &docgo.DocsGroup{
  46. Title: "Web Application",
  47. Docs: []*docgo.DocBuilder{
  48. advanced_functions.PageFuncAndEventFunc,
  49. advanced_functions.TheGoHTMLBuilder,
  50. advanced_functions.ItsTheWholeHouse,
  51. advanced_functions.LazyPortalsAndReload,
  52. advanced_functions.LayoutFunctionAndPageInjector,
  53. advanced_functions.SwitchPagesWithPushState,
  54. advanced_functions.ReloadPageWithAFlash,
  55. advanced_functions.PartialRefreshWithPortal,
  56. advanced_functions.ManipulatePageURLInEventFunc,
  57. advanced_functions.SummaryOfEventResponse,
  58. advanced_functions.WebScope,
  59. advanced_functions.EventHandling,
  60. basics.FormHandling,
  61. },
  62. },
  63. &docgo.DocsGroup{
  64. Title: "UI Components",
  65. Docs: []*docgo.DocBuilder{
  66. // TODO: move BasicInputs to ATasteOfUsingVuetifyInGo
  67. basics.BasicInputs,
  68. advanced_functions.ATasteOfUsingVuetifyInGo,
  69. // vuetifyx
  70. basics.LinkageSelect,
  71. basics.AutoComplete,
  72. // build ui component
  73. digging_deeper.CompositeNewComponentWithGo,
  74. digging_deeper.IntegrateAHeavyVueComponent,
  75. },
  76. },
  77. &docgo.DocsGroup{
  78. Title: "Appendix",
  79. Docs: []*docgo.DocBuilder{
  80. docgo.Doc(utils.ExamplesDoc()).
  81. Title("All Demo Examples").
  82. Slug("appendix/all-demo-examples"),
  83. },
  84. },
  85. }