mkdocs.yml 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. site_name: PHPWord
  2. site_url: https://phpoffice.github.io/PHPWord
  3. repo_url: https://github.com/PHPOffice/PHPWord
  4. repo_name: PHPOffice/PHPWord
  5. edit_uri: edit/develop/docs/
  6. ## Theme
  7. theme:
  8. name: material
  9. palette:
  10. primary: indigo
  11. features:
  12. - search.highlight
  13. - search.suggest
  14. ## Plugins
  15. plugins:
  16. - search
  17. - autolink_references:
  18. autolinks:
  19. - reference_prefix: GP-
  20. target_url: https://github.com/<num>
  21. - reference_prefix: GH-
  22. target_url: https://github.com/PHPOffice/PHPWord/issues/<num>
  23. - reference_prefix: CP-
  24. target_url: https://archive.codeplex.com/?p=phpword&<num>
  25. ## Config
  26. extra:
  27. generator: false
  28. markdown_extensions:
  29. ## Syntax highlighting
  30. - pymdownx.highlight
  31. - pymdownx.superfences
  32. ## Support for emojis
  33. - pymdownx.emoji:
  34. emoji_index: !!python/name:materialx.emoji.twemoji
  35. emoji_generator: !!python/name:materialx.emoji.to_svg
  36. ## Support for call-outs
  37. - admonition
  38. - pymdownx.details
  39. use_directory_urls: false
  40. ## Navigation
  41. nav:
  42. - Introduction: 'index.md'
  43. - Install: 'install.md'
  44. - Usage:
  45. - Introduction: 'usage/introduction.md'
  46. - Containers: 'usage/containers.md'
  47. - Elements:
  48. - Introduction: 'usage/elements/index.md'
  49. - Chart: 'usage/elements/chart.md'
  50. - Checkbox: 'usage/elements/checkbox.md'
  51. - Comment: 'usage/elements/comment.md'
  52. - Field: 'usage/elements/field.md'
  53. - Footnote & Endnote: 'usage/elements/note.md'
  54. - Formula: 'usage/elements/formula.md'
  55. - Image: 'usage/elements/image.md'
  56. - Line: 'usage/elements/line.md'
  57. - Link: 'usage/elements/link.md'
  58. - List: 'usage/elements/list.md'
  59. - OLE Object: 'usage/elements/oleobject.md'
  60. - Page Break: 'usage/elements/pagebreak.md'
  61. - Preserve Text: 'usage/elements/preservetext.md'
  62. - Ruby: 'usage/elements/ruby.md'
  63. - Text: 'usage/elements/text.md'
  64. - TextBox: 'usage/elements/textbox.md'
  65. - Text Break: 'usage/elements/textbreak.md'
  66. - Table: 'usage/elements/table.md'
  67. - Table of contents: 'usage/elements/toc.md'
  68. - Title: 'usage/elements/title.md'
  69. - Track Changes: 'usage/elements/trackchanges.md'
  70. - Watermark: 'usage/elements/watermark.md'
  71. - Styles:
  72. - Chart: 'usage/styles/chart.md'
  73. - Font: 'usage/styles/font.md'
  74. - Image: 'usage/styles/image.md'
  75. - Numbering Level: 'usage/styles/numberinglevel.md'
  76. - Paragraph: 'usage/styles/paragraph.md'
  77. - Section: 'usage/styles/section.md'
  78. - Table: 'usage/styles/table.md'
  79. - Template Processing: 'usage/template.md'
  80. - Readers: 'usage/readers.md'
  81. - Writers: 'usage/writers.md'
  82. - FAQ: 'faq.md'
  83. - How to: 'howto.md'
  84. - Credits: 'credits.md'
  85. - Releases:
  86. - '1.x':
  87. - '1.5.0 (WIP)': 'changes/1.x/1.5.0.md'
  88. - '1.4.0': 'changes/1.x/1.4.0.md'
  89. - '1.3.0': 'changes/1.x/1.3.0.md'
  90. - '1.2.0': 'changes/1.x/1.2.0.md'
  91. - '1.1.0': 'changes/1.x/1.1.0.md'
  92. - '1.0.0': 'changes/1.x/1.0.0.md'
  93. - '0.x':
  94. - '0.18.3': 'changes/0.x/0.18.3.md'
  95. - '0.18.2': 'changes/0.x/0.18.2.md'
  96. - '0.18.1': 'changes/0.x/0.18.1.md'
  97. - '0.18.0': 'changes/0.x/0.18.0.md'
  98. - '0.17.0': 'changes/0.x/0.17.0.md'
  99. - '0.16.0': 'changes/0.x/0.16.0.md'
  100. - '0.15.0': 'changes/0.x/0.15.0.md'
  101. - '0.14.0': 'changes/0.x/0.14.0.md'
  102. - '0.13.0': 'changes/0.x/0.13.0.md'
  103. - '0.12.1': 'changes/0.x/0.12.1.md'
  104. - '0.12.0': 'changes/0.x/0.12.0.md'
  105. - '0.11.1': 'changes/0.x/0.11.1.md'
  106. - '0.11.0': 'changes/0.x/0.11.0.md'
  107. - '0.10.1': 'changes/0.x/0.10.1.md'
  108. - '0.10.0': 'changes/0.x/0.10.0.md'
  109. - '0.9.1': 'changes/0.x/0.9.1.md'
  110. - '0.9.0': 'changes/0.x/0.9.0.md'
  111. - '0.8.1': 'changes/0.x/0.8.1.md'
  112. - '0.8.0': 'changes/0.x/0.8.0.md'
  113. - '0.7.0': 'changes/0.x/0.7.0.md'
  114. - Developers:
  115. - 'Coveralls': 'https://coveralls.io/github/PHPOffice/PHPWord'
  116. - 'Code Coverage': 'coverage/index.html'
  117. - 'PHPDoc': 'docs/index.html'