Merge pull request #364 from mwestphal/jekyll_doc

Rework documentation completely

.gitattributes

@@ -1,8 +1,3 @@
 testing/data/**/* filter=lfs diff=lfs merge=lfs -text
 testing/baselines/**/* filter=lfs diff=lfs merge=lfs -text
 testing/data/DATA_LICENSES.md !filter !diff !merge text
-documentation/content/icon/**/* filter=lfs diff=lfs merge=lfs -text
-documentation/content/gallery/*.jpg filter=lfs diff=lfs merge=lfs -text
-documentation/content/gallery/*.png filter=lfs diff=lfs merge=lfs -text
-documentation/content/gallery/*.gif filter=lfs diff=lfs merge=lfs -text
-documentation/content/gallery/*.webm filter=lfs diff=lfs merge=lfs -text

LICENSE → LICENSE.md

@@ -1,5 +1,13 @@
+---
+layout: default
+title: License
+parent: Licenses
+nav_order: 0
+---
+
 BSD 3-Clause License
 
+```
 Copyright 2019-2021 Kitware SAS
 Copyright 2021-2022 Michael Migliore, Mathieu Westphal
 All rights reserved.
@@ -28,3 +36,4 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```

_config.yml

@@ -0,0 +1,29 @@
+remote_theme: just-the-docs/just-the-docs
+plugins:
+  - jekyll-remote-theme
+  - jekyll-relative-links
+relative_links:
+  enabled: true
+  collections: true
+include:
+  - _readme.md
+  - _licenses.md
+exclude:
+  - testing/data/DATA_LICENSES.md
+title: F3D
+description: Fast and minimalist 3D viewer
+logo: /resources/logotype.svg
+color_scheme: dark
+
+# Aux links for the upper right navigation
+aux_links:
+  "<img src=\"https://user-images.githubusercontent.com/3129530/197903476-11d9c41d-73b0-461f-93e8-c8c00c680e6e.png\" width=\"30px\">":
+    - "//github.com/f3d-app/f3d"
+
+# Makes Aux links open in a new tab.
+aux_links_new_tab: true
+
+# External navigation links
+nav_external_links:
+  - title: Download F3D
+    url: https://github.com/f3d-app/f3d/releases

_includes/head_custom.html

@@ -0,0 +1 @@
+<link rel="shortcut icon" href="resources/logo.ico" type="image/x-icon">

_licenses.md

@@ -0,0 +1,6 @@
+---
+layout: default
+title: Licenses
+nav_order: 5
+has_children: true
+---

_readme.md

@@ -0,0 +1,9 @@
+---
+layout: default
+title: Home
+nav_order: 0
+description: "F3D - Fast and minimalist 3D viewer"
+permalink: /
+---
+
+{% include_relative README.md %}

cmake/installing.cmake

@@ -46,7 +46,7 @@ if (UNIX AND NOT APPLE AND NOT ANDROID)
   set(F3D_DOC_DIR ${CMAKE_INSTALL_DOCDIR})
 endif()
 
-install(FILES LICENSE THIRD_PARTY_LICENSES.md README.md
+install(FILES LICENSE.md doc/THIRD_PARTY_LICENSES.md README.md
   DESTINATION ${F3D_DOC_DIR} COMPONENT documentation)
 
 list(APPEND config_files
@@ -142,7 +142,7 @@ elseif(WIN32)
   if (F3D_INSTALL_LOGOS_FOR_NSIS_PACKAGING)
     install(FILES "${CMAKE_SOURCE_DIR}/resources/logo.ico"
       DESTINATION "." COMPONENT assets)
-    install(FILES "${CMAKE_SOURCE_DIR}/resources/logo.bmp"
+    install(FILES "${CMAKE_SOURCE_DIR}/resources/logotype64.bmp"
       DESTINATION "." COMPONENT assets)
   endif()
   if (F3D_INSTALL_DEFAULT_CONFIGURATION_FILE)

cmake/packaging.cmake

@@ -7,7 +7,7 @@ set(CPACK_PACKAGE_VENDOR "${PROJECT_NAME}-app")
 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "${PROJECT_DESCRIPTION}")
 set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_SOURCE_DIR}/README.md")
 set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md")
-set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE")
+set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE.md")
 set(CPACK_PACKAGE_EXECUTABLES f3d f3d)
 set(CPACK_CREATE_DESKTOP_LINKS f3d)
 
@@ -20,7 +20,7 @@ if(WIN32 AND NOT UNIX)
   # For some reason, we need Windows backslashes
   # https://www.howtobuildsoftware.com/index.php/how-do/PNb/cmake-nsis-bmp-cpack-how-to-set-an-icon-in-nsis-install-cmake
   # BMP3 format is also required (recommended size is 150x57)
-  set(CPACK_PACKAGE_ICON "${CMAKE_SOURCE_DIR}/resources\\\\logo.bmp")
+  set(CPACK_PACKAGE_ICON "${CMAKE_SOURCE_DIR}/resources\\\\logotype64.bmp")
   set(CPACK_NSIS_MENU_LINKS ${f3d_url} "F3D Website")
   set(CPACK_NSIS_MODIFY_PATH ON)
   set(CPACK_NSIS_MUI_ICON ${f3d_ico})