doc_tree.go 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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.Worker,
  40. },
  41. },
  42. &docgo.DocsGroup{
  43. Title: "Web Application",
  44. Docs: []*docgo.DocBuilder{
  45. advanced_functions.PageFuncAndEventFunc,
  46. advanced_functions.TheGoHTMLBuilder,
  47. advanced_functions.ItsTheWholeHouse,
  48. advanced_functions.LazyPortalsAndReload,
  49. advanced_functions.LayoutFunctionAndPageInjector,
  50. advanced_functions.SwitchPagesWithPushState,
  51. advanced_functions.ReloadPageWithAFlash,
  52. advanced_functions.PartialRefreshWithPortal,
  53. advanced_functions.ManipulatePageURLInEventFunc,
  54. advanced_functions.SummaryOfEventResponse,
  55. advanced_functions.WebScope,
  56. advanced_functions.EventHandling,
  57. basics.FormHandling,
  58. },
  59. },
  60. &docgo.DocsGroup{
  61. Title: "UI Components",
  62. Docs: []*docgo.DocBuilder{
  63. // TODO: move BasicInputs to ATasteOfUsingVuetifyInGo
  64. basics.BasicInputs,
  65. advanced_functions.ATasteOfUsingVuetifyInGo,
  66. // vuetifyx
  67. basics.LinkageSelect,
  68. basics.AutoComplete,
  69. // build ui component
  70. digging_deeper.CompositeNewComponentWithGo,
  71. digging_deeper.IntegrateAHeavyVueComponent,
  72. },
  73. },
  74. &docgo.DocsGroup{
  75. Title: "Appendix",
  76. Docs: []*docgo.DocBuilder{
  77. docgo.Doc(utils.ExamplesDoc()).
  78. Title("All Demo Examples").
  79. Slug("appendix/all-demo-examples"),
  80. },
  81. },
  82. }