Home Explore Help
Sign In
kotnik
/
shaarli
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
shaarli
/
mkdocs.yml

mkdocs.yml 2.2 KB
Permalink History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556 
  1. site_name: Shaarli Documentation
    2. 

  2. repo_url: https://github.com/shaarli/Shaarli
    3. 

  3. edit_uri: edit/master/doc/md
    4. 

  4. site_description: The personal, minimalist, super-fast, database free, bookmarking service
    5. 

  5. theme:
    6. 

  6.   name: readthedocs
    7. 

  7.   custom_dir: doc/custom_theme/
    8. 

  8. docs_dir: doc/md
    9. 

  9. site_dir: doc/html
    10. 

  10. # Disable strict mode until ReadTheDocs provides up-to-date MkDocs settings:
    11. 

  11. # - https://github.com/shaarli/Shaarli/issues/1179
    12. 

  12. # - https://github.com/rtfd/readthedocs.org/issues/4314
    13. 

  13. # strict: true
    14. 

  14. 

  15. pages:
    16. 

  16. - Home: index.md
    17. 

  17. - Setup:
    18. 

  18.     - Download and Installation: Download-and-Installation.md
    19. 

  19.     - Upgrade and migration: Upgrade-and-migration.md
    20. 

  20.     - Server configuration: Server-configuration.md
    21. 

  21.     - Server security: Server-security.md
    22. 

  22.     - Shaarli configuration: Shaarli-configuration.md
    23. 

  23.     - Plugins: Plugins.md
    24. 

  24. - Docker:
    25. 

  25.     - Docker 101: docker/docker-101.md
    26. 

  26.     - Shaarli images: docker/shaarli-images.md
    27. 

  27.     - Reverse proxy configuration: docker/reverse-proxy-configuration.md
    28. 

  28.     - Docker resources: docker/resources.md
    29. 

  29. - Usage:
    30. 

  30.     - Browsing and searching: Browsing-and-searching.md
    31. 

  31.     - Sharing content: Sharing-content.md
    32. 

  32.     - RSS feeds: RSS-feeds.md
    33. 

  33.     - REST API: REST-API.md
    34. 

  34.     - Community & Related software: Community-&-Related-software.md
    35. 

  35. - Guides:
    36. 

  36.     - Install Shaarli on Debian 9 with Docker: guides/install-shaarli-with-debian9-and-docker.md
    37. 

  37.     - Backup, restore, import and export: guides/backup-restore-import-export.md
    38. 

  38.     - Various hacks: guides/various-hacks.md
    39. 

  39. - Development:
    40. 

  40.     - Development guidelines: Development-guidelines.md
    41. 

  41.     - Continuous integration tools: Continuous-integration-tools.md
    42. 

  42.     - GnuPG signature: GnuPG-signature.md
    43. 

  43.     - Directory structure: Directory-structure.md
    44. 

  44.     - Link Structure: Link-structure.md
    45. 

  45.     - 3rd party libraries: 3rd-party-libraries.md
    46. 

  46.     - Plugin System: Plugin-System.md
    47. 

  47.     - Release Shaarli: Release-Shaarli.md
    48. 

  48.     - Versioning and Branches: Versioning-and-Branches.md
    49. 

  49.     - Security: Security.md
    50. 

  50.     - Static analysis: Static-analysis.md
    51. 

  51.     - Translations: Translations.md
    52. 

  52.     - Theming: Theming.md
    53. 

  53.     - Unit tests: Unit-tests.md
    54. 

  54.     - Unit tests inside Docker: Unit-tests-Docker.md
    55. 

  55. - FAQ: FAQ.md
    56. 

  56. - Troubleshooting: Troubleshooting.md
    57.