FilesExpand file tree

 main

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

129 lines (122 loc) · 4.33 KB

 main

/

mkdocs.yml

Top

File metadata and controls

• Code
• Blame

129 lines (122 loc) · 4.33 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

site_name: FastAPI Pagination

site_author: Yurii Karabas

site_description: FastAPI Pagination

copyright: "Copyright © 2024 Yurii Karabas"

repo_url: https://github.com/uriyyo/fastapi-pagination

repo_name: uriyyo/fastapi-pagination

theme:

name: 'material'

palette:

- media: "(prefers-color-scheme: light)"

scheme: default

primary: teal

accent: cyan

toggle:

icon: material/lightbulb-outline

name: "Switch to dark mode"

- media: "(prefers-color-scheme: dark)"

scheme: slate

primary: teal

accent: cyan

toggle:

icon: material/lightbulb

name: "Switch to light mode"

features:

- content.tabs.link

- content.code.annotate

- content.code.copy

- announce.dismiss

- navigation.footer

- navigation.tabs

- navigation.tabs.sticky

- navigation.indexes

- navigation.instant

- navigation.instant.prefetch

- navigation.instant.preview

- navigation.instant.progress

- navigation.path

- navigation.top

- navigation.tracking

- search.suggest

- toc.follow

favicon: img/small-logo.png

logo: img/small-logo.png

icon:

repo: fontawesome/brands/github

extra_javascript:

# - 'http://localhost:8001/run_code_main.js'

- 'https://uriyyo.github.io/mkdocs-run-code/run_code_main.js'

nav:

- "General": index.md

- "Learn":

- "Pagination":

- "General": learn/pagination/general.md

- "Techniques": learn/pagination/techniques.md

- "Tutorial - User Guide":

- "First Steps": learn/tutorial_user_guide/first_steps.md

- "Elements": learn/tutorial_user_guide/elements.md

- "Add to Route": learn/tutorial_user_guide/add_to_route.md

- "Own Page Model": learn/tutorial_user_guide/own_page_model.md

- "Items Transformer": learn/tutorial_user_guide/items_transformer.md

- "Links": learn/tutorial_user_guide/page_links.md

- "Paginate": learn/tutorial_user_guide/paginate.md

- "Tutorial - Advanced":

- "Low-Level API": learn/tutorial_advanced/low_level_api.md

- "Custom paginate": learn/tutorial_advanced/custom_paginate.md

- "Customization":

- "General": customization/general.md

- "Available Customizers":

- "UseName": customization/customizers/use_name.md

- "UseModule": customization/customizers/use_module.md

- "UseIncludeTotal": customization/customizers/use_include_total.md

- "UseQuotedCursor": customization/customizers/use_quoted_cursor.md

- "UseParams": customization/customizers/use_params.md

- "UseParamsFields": customization/customizers/use_params_fields.md

- "UseOptionalParams": customization/customizers/use_optional_params.md

- "UseModelConfig": customization/customizers/use_model_config.md

- "UseExcludedFields": customization/customizers/use_excluded_fields.md

- "UseFieldsAliases": customization/customizers/use_fields_aliases.md

- "UseAdditionalFields": customization/customizers/use_additional_fields.md

- "Customizers Combinations": customization/customizer_combinations.md

- "Integrations":

- "Available": integrations/available.md

- "SQLAlchemy":

- "General": integrations/sqlalchemy/general.md

- "Paginate Function": integrations/sqlalchemy/paginate.md

- "Cursor Pagination": integrations/sqlalchemy/cursor_pagination.md

- "Relationships": integrations/sqlalchemy/relationships.md

- "Migration to v0.13.x": "v0_13_migration.md"

- "FAQ":

- "FAQ": faq/faq.md

- "Contributing": contributing.md

- "License": license.md

markdown_extensions:

- tables

- toc:

permalink: true

title: Page contents

- admonition

- pymdownx.details

- pymdownx.superfences

- pymdownx.highlight:

pygments_lang_class: true

- pymdownx.extra

- pymdownx.emoji:

emoji_index: !!python/name:material.extensions.emoji.twemoji

emoji_generator: !!python/name:material.extensions.emoji.to_svg

- pymdownx.tabbed:

alternate_style: true

- mdx_include:

base_path: docs

plugins:

- search

extra:

social:

- icon: fontawesome/brands/github

link: https://github.com/uriyyo/fastapi-pagination/

- icon: fontawesome/brands/linkedin

link: https://www.linkedin.com/in/uriyyo/

watch:

- docs

- README.md

- mkdocs.yml